Skip to content

Work Queue API V3 Developer Guide

Overview

This guide consolidates the 11 Work Queue API source documents using one consistent section structure.

Base URL and environments

All API calls use the following base URL:

https://api3.sprinklr.com/{env}/api/v3

For example, the Work Queue resource is:

https://api3.sprinklr.com/{env}/api/v3/workQueue

Replace {env} with the environment identifier assigned to your Sprinklr instance. Supported environment identifiers include:

prod, prod0, prod2, prod3, prod4, prod5, prod6, prod8, prod11, prod12, prod15, prod16, prod17, prod18, prod19, prod21, and prod25.

The credentials and environment must belong to the same workspace. Keep the base URL in configuration so that changing environments does not require a code change.

Authentication

KeyValueDescription
AuthorizationBearer {token}Authenticates the user with the server.
Keyapi-keyAuthenticates the application with the server.
Content-Typeapplication/jsonIdentifies the request media type.
Acceptapplication/jsonDetermines the acceptable response type.

POST - Create Work Queue

Creates a work queue with routing, assignment, timeout, sharing, and SLA settings.

API endpoint

POST /api/v3/workQueue

Request parameters

ParameterRequired/OptionalDescriptionType
workQueueNameRequiredName of the work queue.String
workQueueTypeRequiredType of work queue.String
assignmentProviderRequiredAssignment provider.String
routingStrategyRequiredRouting strategy.String
usersOptionalAssociated user IDs.Array<String>
userGroupsOptionalAssociated user-group IDs.Array<String>
availableStatusesOptionalAgent statuses eligible for work.Array<String>
stickinessTimeoutOptionalStickiness timeout.Long
capacityOptionalMaximum queue capacity.Integer
sortKeyRequiredWork-item sort attribute.String
sortDirectionRequiredSort direction.String
routingEvaluationMethodRequiredRouting evaluation method.String
shareConfigsOptionalSharing configurations.Array<Object>
voiceConfigEnabledOptionalIndicates whether voice configuration is enabled.Boolean

Example request

curl -X POST \
  'https://api3.sprinklr.com/{env}/api/v3/workQueue' \
  -H 'Authorization: Bearer {Enter your Access Token}' \
  -H 'Key: {Enter your API KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"workQueueName":"Test Queue","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","sortKey":"WORK_CREATION_TIME","sortDirection":"ASC","routingEvaluationMethod":"ALL_SKILL_MATCHING"}'

Example response

{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}

Response parameters

ParameterSub-parameterDescriptionType
dataContains returned work queue details.Array<Object>
dataidUnique work queue identifier.String
workQueueNameWork queue name.String
workQueueTypeWork queue type.String
useUnifiedRoutingIndicates whether unified routing is enabled.Boolean
assignmentProviderAssignment provider.String
routingStrategyRouting strategy.String
userGroupsAssociated user-group IDs.Array<String>
usersAssociated user IDs.Array<String>
availableStatusesEligible agent statuses.Array<String>
stickinessTimeoutStickiness timeout.Long
capacityQueue capacity.Integer
routingEvaluationMethodRouting evaluation method.String
additionalAdditional timeout-unit settings.Object
shareConfigsSharing configurations.Array<Object>
voiceConfigEnabledIndicates whether voice is enabled.Boolean
errorsContains processing errors.Array<Object>
errorsidError identifier.String
codeError code.Integer
messageError description.String

GET - Fetch Work Queue

Fetches a work queue by its unique identifier.

API endpoint

GET /api/v3/workQueue?id={workQueueId}

Query parameters

ParameterRequired/OptionalDescriptionType
idRequiredUnique identifier of the work queue.String

Example request

curl -X GET \
  'https://api3.sprinklr.com/{env}/api/v3/workQueue?id={workQueueId}' \
  -H 'Authorization: Bearer {Enter your Access Token}' \
  -H 'Key: {Enter your API KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

Example response

{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}

Response parameters

ParameterSub-parameterDescriptionType
dataContains returned work queue details.Array<Object>
dataidUnique work queue identifier.String
workQueueNameWork queue name.String
workQueueTypeWork queue type.String
useUnifiedRoutingIndicates whether unified routing is enabled.Boolean
assignmentProviderAssignment provider.String
routingStrategyRouting strategy.String
userGroupsAssociated user-group IDs.Array<String>
usersAssociated user IDs.Array<String>
availableStatusesEligible agent statuses.Array<String>
stickinessTimeoutStickiness timeout.Long
capacityQueue capacity.Integer
routingEvaluationMethodRouting evaluation method.String
additionalAdditional timeout-unit settings.Object
shareConfigsSharing configurations.Array<Object>
voiceConfigEnabledIndicates whether voice is enabled.Boolean
errorsContains processing errors.Array<Object>
errorsidError identifier.String
codeError code.Integer
messageError description.String

GET - Fetch Work Queues by ID

Fetches one or more work queues by ID and supports partial success.

API endpoint

GET /api/v3/workQueue?id={workQueueId1},{workQueueId2},{workQueueId3}

Query parameters

ParameterRequired/OptionalDescriptionType
idRequiredComma-separated list of work queue identifiers.String

Example request

curl -X GET \
  'https://api3.sprinklr.com/{env}/api/v3/workQueue?id={workQueueId1},{workQueueId2},{workQueueId3}' \
  -H 'Authorization: Bearer {Enter your Access Token}' \
  -H 'Key: {Enter your API KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

Example response

{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}

Response parameters

ParameterSub-parameterDescriptionType
dataContains returned work queue details.Array<Object>
dataidUnique work queue identifier.String
workQueueNameWork queue name.String
workQueueTypeWork queue type.String
useUnifiedRoutingIndicates whether unified routing is enabled.Boolean
assignmentProviderAssignment provider.String
routingStrategyRouting strategy.String
userGroupsAssociated user-group IDs.Array<String>
usersAssociated user IDs.Array<String>
availableStatusesEligible agent statuses.Array<String>
stickinessTimeoutStickiness timeout.Long
capacityQueue capacity.Integer
routingEvaluationMethodRouting evaluation method.String
additionalAdditional timeout-unit settings.Object
shareConfigsSharing configurations.Array<Object>
voiceConfigEnabledIndicates whether voice is enabled.Boolean
errorsContains processing errors.Array<Object>
errorsidError identifier.String
codeError code.Integer
messageError description.String

GET - Fetch Work Queue by ID: Not Found

Shows the response when a queue does not exist or is inaccessible.

API endpoint

GET /api/v3/workQueue?id={workQueueId}

Query parameters

ParameterRequired/OptionalDescriptionType
idRequiredUnique identifier of the work queue.String

Example request

curl -X GET \
  'https://api3.sprinklr.com/{env}/api/v3/workQueue?id={workQueueId}' \
  -H 'Authorization: Bearer {Enter your Access Token}' \
  -H 'Key: {Enter your API KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

Example response

{"data":[],"errors":[{"id":"699c3307440ba77b14af2a86","code":404,"message":"Work queue not found. Verify the work queue exists and you have access permissions."}]}

Response parameters

ParameterSub-parameterDescriptionType
dataContains returned work queue details.Array<Object>
dataidUnique work queue identifier.String
workQueueNameWork queue name.String
workQueueTypeWork queue type.String
useUnifiedRoutingIndicates whether unified routing is enabled.Boolean
assignmentProviderAssignment provider.String
routingStrategyRouting strategy.String
userGroupsAssociated user-group IDs.Array<String>
usersAssociated user IDs.Array<String>
availableStatusesEligible agent statuses.Array<String>
stickinessTimeoutStickiness timeout.Long
capacityQueue capacity.Integer
routingEvaluationMethodRouting evaluation method.String
additionalAdditional timeout-unit settings.Object
shareConfigsSharing configurations.Array<Object>
voiceConfigEnabledIndicates whether voice is enabled.Boolean
errorsContains processing errors.Array<Object>
errorsidError identifier.String
codeError code.Integer
messageError description.String

GET - Fetch Work Queue by ID

Fetches a single matching work queue.

API endpoint

GET /api/v3/workQueue?id={workQueueId}

Query parameters

ParameterRequired/OptionalDescriptionType
idRequiredUnique identifier of the work queue.String

Example request

curl -X GET \
  'https://api3.sprinklr.com/{env}/api/v3/workQueue?id={workQueueId}' \
  -H 'Authorization: Bearer {Enter your Access Token}' \
  -H 'Key: {Enter your API KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

Example response

{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}

Response parameters

ParameterSub-parameterDescriptionType
dataContains returned work queue details.Array<Object>
dataidUnique work queue identifier.String
workQueueNameWork queue name.String
workQueueTypeWork queue type.String
useUnifiedRoutingIndicates whether unified routing is enabled.Boolean
assignmentProviderAssignment provider.String
routingStrategyRouting strategy.String
userGroupsAssociated user-group IDs.Array<String>
usersAssociated user IDs.Array<String>
availableStatusesEligible agent statuses.Array<String>
stickinessTimeoutStickiness timeout.Long
capacityQueue capacity.Integer
routingEvaluationMethodRouting evaluation method.String
additionalAdditional timeout-unit settings.Object
shareConfigsSharing configurations.Array<Object>
voiceConfigEnabledIndicates whether voice is enabled.Boolean
errorsContains processing errors.Array<Object>
errorsidError identifier.String
codeError code.Integer
messageError description.String

GET - Fetch Work Queue by Name

Fetches work queues using one or more exact names.

API endpoint

GET /api/v3/workQueue?name={workQueueName}

Query parameters

ParameterRequired/OptionalDescriptionType
nameRequiredExact work queue name or comma-separated list of exact names.String

Example request

curl -X GET \
  'https://api3.sprinklr.com/{env}/api/v3/workQueue?name={workQueueName}' \
  -H 'Authorization: Bearer {Enter your Access Token}' \
  -H 'Key: {Enter your API KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

Example response

{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}

Response parameters

ParameterSub-parameterDescriptionType
dataContains returned work queue details.Array<Object>
dataidUnique work queue identifier.String
workQueueNameWork queue name.String
workQueueTypeWork queue type.String
useUnifiedRoutingIndicates whether unified routing is enabled.Boolean
assignmentProviderAssignment provider.String
routingStrategyRouting strategy.String
userGroupsAssociated user-group IDs.Array<String>
usersAssociated user IDs.Array<String>
availableStatusesEligible agent statuses.Array<String>
stickinessTimeoutStickiness timeout.Long
capacityQueue capacity.Integer
routingEvaluationMethodRouting evaluation method.String
additionalAdditional timeout-unit settings.Object
shareConfigsSharing configurations.Array<Object>
voiceConfigEnabledIndicates whether voice is enabled.Boolean
errorsContains processing errors.Array<Object>
errorsidError identifier.String
codeError code.Integer
messageError description.String

GET - Fetch Work Queue Statistics

Fetches agent, wait-time, backlog, business-hours, and assignment statistics.

API endpoint

GET /api/v3/workQueue/workQueueStats?workQueueId={workQueueId}

Query parameters

ParameterRequired/OptionalDescriptionType
workQueueIdRequiredUnique identifier of the work queue.String

Example request

curl -X GET \
  'https://api3.sprinklr.com/{env}/api/v3/workQueue/workQueueStats?workQueueId={workQueueId}' \
  -H 'Authorization: Bearer {Enter your Access Token}' \
  -H 'Key: {Enter your API KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

Example response

{"data":{"numberOfAvailableAgents":0,"numberOfIdleAgents":0,"numberOfLoggedInAgents":0,"maxIdleAgentTime":0,"estimatedWaitTimeMillis":0,"averageWaitTimeMillis":0,"oldestCustomerWaitTime":0,"currentBackLog":0,"businessHourStartTime":1786446000000,"businessHourEndTime":1786500000000,"canAssignNewCase":false},"errors":[]}

Response parameters

ParameterDescriptionType
dataContains work queue statistics.Object
numberOfAvailableAgentsNumber of available agents.Integer
numberOfIdleAgentsNumber of idle agents.Integer
numberOfLoggedInAgentsNumber of logged-in agents.Integer
maxIdleAgentTimeMaximum agent idle time.Long
estimatedWaitTimeMillisEstimated wait time; -1 means unavailable.Long
averageWaitTimeMillisAverage wait time.Long
oldestCustomerWaitTimeOldest customer wait time.Long
currentBackLogCurrent backlog.Integer
businessHourStartTimeBusiness-hours start time.Epoch
businessHourEndTimeBusiness-hours end time.Epoch
canAssignNewCaseIndicates whether a case can be assigned.Boolean
errorsContains processing errors.Array

POST - Fetch Skill-Based Work Queue Statistics

Fetches work queue statistics using skill, proficiency, priority, and channel criteria.

API endpoint

POST /api/v3/workQueue/workQueueStatsSkillBased

Request parameters

ParameterSub-parameterRequired/OptionalDescriptionType
workQueueIdRequiredWork queue identifier.String
skillNameVsProficiencyRequiredMaps skills to minimum proficiency values.Object
skillNameRequiredSkill name used as a dynamic key.String
proficiencyRequiredMinimum proficiency value.Integer
priorityRequiredAssignment priority.Integer
channelForAssignmentCheckRequiredChannel evaluated for assignment.String

Example request

curl -X POST \
  'https://api3.sprinklr.com/{env}/api/v3/workQueue/workQueueStatsSkillBased' \
  -H 'Authorization: Bearer {Enter your Access Token}' \
  -H 'Key: {Enter your API KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"workQueueId":"{workQueueId}","skillNameVsProficiency":{"English":5},"priority":1,"channelForAssignmentCheck":"VOICE"}'

Example response

{"data":{"numberOfAvailableAgents":0,"numberOfIdleAgents":0,"numberOfLoggedInAgents":0,"maxIdleAgentTime":0,"estimatedWaitTimeMillis":0,"averageWaitTimeMillis":0,"oldestCustomerWaitTime":0,"currentBackLog":0,"businessHourStartTime":1786446000000,"businessHourEndTime":1786500000000,"canAssignNewCase":false},"errors":[]}

Response parameters

ParameterDescriptionType
dataContains work queue statistics.Object
numberOfAvailableAgentsNumber of available agents.Integer
numberOfIdleAgentsNumber of idle agents.Integer
numberOfLoggedInAgentsNumber of logged-in agents.Integer
maxIdleAgentTimeMaximum agent idle time.Long
estimatedWaitTimeMillisEstimated wait time; -1 means unavailable.Long
averageWaitTimeMillisAverage wait time.Long
oldestCustomerWaitTimeOldest customer wait time.Long
currentBackLogCurrent backlog.Integer
businessHourStartTimeBusiness-hours start time.Epoch
businessHourEndTimeBusiness-hours end time.Epoch
canAssignNewCaseIndicates whether a case can be assigned.Boolean
errorsContains processing errors.Array

GET - Fetch Work Queues by ID

Fetches multiple matching work queues by ID.

API endpoint

GET /api/v3/workQueue?id={workQueueId1},{workQueueId2}

Query parameters

ParameterRequired/OptionalDescriptionType
idRequiredComma-separated list of work queue identifiers.String

Example request

curl -X GET \
  'https://api3.sprinklr.com/{env}/api/v3/workQueue?id={workQueueId1},{workQueueId2}' \
  -H 'Authorization: Bearer {Enter your Access Token}' \
  -H 'Key: {Enter your API KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

Example response

{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}

Response parameters

ParameterSub-parameterDescriptionType
dataContains returned work queue details.Array<Object>
dataidUnique work queue identifier.String
workQueueNameWork queue name.String
workQueueTypeWork queue type.String
useUnifiedRoutingIndicates whether unified routing is enabled.Boolean
assignmentProviderAssignment provider.String
routingStrategyRouting strategy.String
userGroupsAssociated user-group IDs.Array<String>
usersAssociated user IDs.Array<String>
availableStatusesEligible agent statuses.Array<String>
stickinessTimeoutStickiness timeout.Long
capacityQueue capacity.Integer
routingEvaluationMethodRouting evaluation method.String
additionalAdditional timeout-unit settings.Object
shareConfigsSharing configurations.Array<Object>
voiceConfigEnabledIndicates whether voice is enabled.Boolean
errorsContains processing errors.Array<Object>
errorsidError identifier.String
codeError code.Integer
messageError description.String

GET - Fetch Work Queues by User

Fetches work queues accessible to the authenticated user.

API endpoint

GET /api/v3/workQueue/workQueuesByUser

Query parameters

This API does not require query parameters.

Example request

curl -X GET \
  'https://api3.sprinklr.com/{env}/api/v3/workQueue/workQueuesByUser' \
  -H 'Authorization: Bearer {Enter your Access Token}' \
  -H 'Key: {Enter your API KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

Example response

{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}

Response parameters

ParameterSub-parameterDescriptionType
dataContains returned work queue details.Array<Object>
dataidUnique work queue identifier.String
workQueueNameWork queue name.String
workQueueTypeWork queue type.String
useUnifiedRoutingIndicates whether unified routing is enabled.Boolean
assignmentProviderAssignment provider.String
routingStrategyRouting strategy.String
userGroupsAssociated user-group IDs.Array<String>
usersAssociated user IDs.Array<String>
availableStatusesEligible agent statuses.Array<String>
stickinessTimeoutStickiness timeout.Long
capacityQueue capacity.Integer
routingEvaluationMethodRouting evaluation method.String
additionalAdditional timeout-unit settings.Object
shareConfigsSharing configurations.Array<Object>
voiceConfigEnabledIndicates whether voice is enabled.Boolean
errorsContains processing errors.Array<Object>
errorsidError identifier.String
codeError code.Integer
messageError description.String

POST - Fetch Skill-Based Work Queue Statistics

Fetches skill-based work queue statistics using assignment criteria.

API endpoint

POST /api/v3/workQueue/workQueueStatsSkillBased

Request parameters

ParameterSub-parameterRequired/OptionalDescriptionType
workQueueIdRequiredWork queue identifier.String
skillNameVsProficiencyRequiredMaps skills to minimum proficiency values.Object
skillNameRequiredSkill name used as a dynamic key.String
proficiencyRequiredMinimum proficiency value.Integer
priorityRequiredAssignment priority.Integer
channelForAssignmentCheckRequiredChannel evaluated for assignment.String

Example request

curl -X POST \
  'https://api3.sprinklr.com/{env}/api/v3/workQueue/workQueueStatsSkillBased' \
  -H 'Authorization: Bearer {Enter your Access Token}' \
  -H 'Key: {Enter your API KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"workQueueId":"{workQueueId}","skillNameVsProficiency":{"English":5},"priority":1,"channelForAssignmentCheck":"VOICE"}'

Example response

{"data":{"numberOfAvailableAgents":0,"numberOfIdleAgents":0,"numberOfLoggedInAgents":0,"maxIdleAgentTime":0,"estimatedWaitTimeMillis":0,"averageWaitTimeMillis":0,"oldestCustomerWaitTime":0,"currentBackLog":0,"businessHourStartTime":1786446000000,"businessHourEndTime":1786500000000,"canAssignNewCase":false},"errors":[]}

Response parameters

ParameterDescriptionType
dataContains work queue statistics.Object
numberOfAvailableAgentsNumber of available agents.Integer
numberOfIdleAgentsNumber of idle agents.Integer
numberOfLoggedInAgentsNumber of logged-in agents.Integer
maxIdleAgentTimeMaximum agent idle time.Long
estimatedWaitTimeMillisEstimated wait time; -1 means unavailable.Long
averageWaitTimeMillisAverage wait time.Long
oldestCustomerWaitTimeOldest customer wait time.Long
currentBackLogCurrent backlog.Integer
businessHourStartTimeBusiness-hours start time.Epoch
businessHourEndTimeBusiness-hours end time.Epoch
canAssignNewCaseIndicates whether a case can be assigned.Boolean
errorsContains processing errors.Array

Migrating from API 2.0

The supplied Work Queue source material does not define an authoritative API 2.0-to-3.0 endpoint mapping. Before migrating an existing integration, compare every API 2.0 operation with the published API 3.0 contract and validate the behavior in a non-production environment.

At minimum, check these API 3.0 behaviors in your client:

  • Fetch results are returned in a data array, including single matches.
  • IDs and names are supplied as query parameters for the shared fetch resource.
  • Comma-separated ID lookups can produce partial success.
  • Statistics operations return a data object rather than a queue array.
  • Optional queue fields vary by configuration and must not be treated as universally present.

Do not migrate by changing only /api/v2/ to /api/v3/. Confirm paths, parameters, authentication, response shapes, status codes, and permissions for each operation.

Use Cases

8.1 Create and verify a work queue

  1. Send POST /api/v3/workQueue with the required configuration.
  2. Save data.id from the response.
  3. Fetch the queue with GET /api/v3/workQueue?id={id}.
  4. Compare the returned configuration with the create response.
  5. Treat the fetched object as the authoritative stored state.

8.2 Resolve names to IDs

  1. URL-encode each exact queue name.
  2. Send the names through the name query parameter.
  3. Read the matching objects from data.
  4. Store and use the returned id values for subsequent statistics calls.
  5. Handle zero or multiple matches instead of assuming exactly one result.

8.3 Handle batch lookup safely

  1. Send comma-separated queue IDs.
  2. Process every object in data.
  3. Process every entry in errors.
  4. Correlate successful objects by their queue id.
  5. Do not retry the entire batch only because one item failed.

8.4 Check whether a new case can be assigned

  • Use workQueueStats for queue-level assignment availability.
  • Use workQueueStatsSkillBased when eligibility depends on required skills, proficiency, priority, or channel.
  • Check canAssignNewCase directly.
  • Use backlog and wait-time values for operational context, not as substitutes for canAssignNewCase.

Endpoint summary

POST /api/v3/workQueue
GET  /api/v3/workQueue?id={workQueueId}
GET  /api/v3/workQueue?id={workQueueId1},{workQueueId2}
GET  /api/v3/workQueue?name={workQueueName}
GET  /api/v3/workQueue?name={workQueueName1},{workQueueName2}
GET  /api/v3/workQueue/workQueuesByUser
GET  /api/v3/workQueue/workQueueStats?workQueueId={workQueueId}
POST /api/v3/workQueue/workQueueStatsSkillBased