ListAllWFMAgents

POST

https://api.cbf.tcn.com/api/v1alpha1/wfm/listallwfmagents

Lists all wfm agents for the org sending the request.
if @include_inactive is true then inactive agents will also be included, otherwise only active agents will be returned.
if @include_skill_proficiencies is true then agents returned will include their skill proficiencies.
if @include_agent_groups is true then the @agent_groups_by_agent response field will be set with a list of agent groups correlating to each agents index in the @wfm_agents field.
if @include_agent_groups is set to true, the @agent_group_schedule_scenario_sid field must be set, so that the agent groups for the correct scenario are returned.
if @include_agent_groups is set to true, and @agent_group_schedule_scenario_sid is not set, the agent groups will not be filtered by schedule scenario.
if @include_agent_groups is set to false, the @agent_group_schedule_scenario_sid will be ignored.
@agent_group_schedule_scenario_sid does not effect which @wfm_agents are returned.
WFM agents with no associated agent_groups will have an empty slice in agent_groups_by_agent at their correlated index.
Errors:

grpc.Internal: error occurs when getting the wfm agents.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/wfm/listallwfmagents' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

Modified at 2025-08-14 21:02:57

UpdateWFMAgent

ListCandidateWFMAgents