This guide consolidates the 11 Work Queue API source documents using one consistent section structure.
All API calls use the following base URL:
https://api3.sprinklr.com/{env}/api/v3For example, the Work Queue resource is:
https://api3.sprinklr.com/{env}/api/v3/workQueueReplace {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.
| Key | Value | Description |
|---|---|---|
| Authorization | Bearer {token} | Authenticates the user with the server. |
| Key | api-key | Authenticates the application with the server. |
| Content-Type | application/json | Identifies the request media type. |
| Accept | application/json | Determines the acceptable response type. |
Creates a work queue with routing, assignment, timeout, sharing, and SLA settings.
POST /api/v3/workQueue
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| workQueueName | Required | Name of the work queue. | String |
| workQueueType | Required | Type of work queue. | String |
| assignmentProvider | Required | Assignment provider. | String |
| routingStrategy | Required | Routing strategy. | String |
| users | Optional | Associated user IDs. | Array<String> |
| userGroups | Optional | Associated user-group IDs. | Array<String> |
| availableStatuses | Optional | Agent statuses eligible for work. | Array<String> |
| stickinessTimeout | Optional | Stickiness timeout. | Long |
| capacity | Optional | Maximum queue capacity. | Integer |
| sortKey | Required | Work-item sort attribute. | String |
| sortDirection | Required | Sort direction. | String |
| routingEvaluationMethod | Required | Routing evaluation method. | String |
| shareConfigs | Optional | Sharing configurations. | Array<Object> |
| voiceConfigEnabled | Optional | Indicates whether voice configuration is enabled. | Boolean |
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"}'{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}| Parameter | Sub-parameter | Description | Type |
|---|---|---|---|
| data | Contains returned work queue details. | Array<Object> | |
| data | id | Unique work queue identifier. | String |
| workQueueName | Work queue name. | String | |
| workQueueType | Work queue type. | String | |
| useUnifiedRouting | Indicates whether unified routing is enabled. | Boolean | |
| assignmentProvider | Assignment provider. | String | |
| routingStrategy | Routing strategy. | String | |
| userGroups | Associated user-group IDs. | Array<String> | |
| users | Associated user IDs. | Array<String> | |
| availableStatuses | Eligible agent statuses. | Array<String> | |
| stickinessTimeout | Stickiness timeout. | Long | |
| capacity | Queue capacity. | Integer | |
| routingEvaluationMethod | Routing evaluation method. | String | |
| additional | Additional timeout-unit settings. | Object | |
| shareConfigs | Sharing configurations. | Array<Object> | |
| voiceConfigEnabled | Indicates whether voice is enabled. | Boolean | |
| errors | Contains processing errors. | Array<Object> | |
| errors | id | Error identifier. | String |
| code | Error code. | Integer | |
| message | Error description. | String |
Fetches a work queue by its unique identifier.
GET /api/v3/workQueue?id={workQueueId}
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| id | Required | Unique identifier of the work queue. | String |
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'{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}| Parameter | Sub-parameter | Description | Type |
|---|---|---|---|
| data | Contains returned work queue details. | Array<Object> | |
| data | id | Unique work queue identifier. | String |
| workQueueName | Work queue name. | String | |
| workQueueType | Work queue type. | String | |
| useUnifiedRouting | Indicates whether unified routing is enabled. | Boolean | |
| assignmentProvider | Assignment provider. | String | |
| routingStrategy | Routing strategy. | String | |
| userGroups | Associated user-group IDs. | Array<String> | |
| users | Associated user IDs. | Array<String> | |
| availableStatuses | Eligible agent statuses. | Array<String> | |
| stickinessTimeout | Stickiness timeout. | Long | |
| capacity | Queue capacity. | Integer | |
| routingEvaluationMethod | Routing evaluation method. | String | |
| additional | Additional timeout-unit settings. | Object | |
| shareConfigs | Sharing configurations. | Array<Object> | |
| voiceConfigEnabled | Indicates whether voice is enabled. | Boolean | |
| errors | Contains processing errors. | Array<Object> | |
| errors | id | Error identifier. | String |
| code | Error code. | Integer | |
| message | Error description. | String |
Fetches one or more work queues by ID and supports partial success.
GET /api/v3/workQueue?id={workQueueId1},{workQueueId2},{workQueueId3}
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| id | Required | Comma-separated list of work queue identifiers. | String |
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'{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}| Parameter | Sub-parameter | Description | Type |
|---|---|---|---|
| data | Contains returned work queue details. | Array<Object> | |
| data | id | Unique work queue identifier. | String |
| workQueueName | Work queue name. | String | |
| workQueueType | Work queue type. | String | |
| useUnifiedRouting | Indicates whether unified routing is enabled. | Boolean | |
| assignmentProvider | Assignment provider. | String | |
| routingStrategy | Routing strategy. | String | |
| userGroups | Associated user-group IDs. | Array<String> | |
| users | Associated user IDs. | Array<String> | |
| availableStatuses | Eligible agent statuses. | Array<String> | |
| stickinessTimeout | Stickiness timeout. | Long | |
| capacity | Queue capacity. | Integer | |
| routingEvaluationMethod | Routing evaluation method. | String | |
| additional | Additional timeout-unit settings. | Object | |
| shareConfigs | Sharing configurations. | Array<Object> | |
| voiceConfigEnabled | Indicates whether voice is enabled. | Boolean | |
| errors | Contains processing errors. | Array<Object> | |
| errors | id | Error identifier. | String |
| code | Error code. | Integer | |
| message | Error description. | String |
Shows the response when a queue does not exist or is inaccessible.
GET /api/v3/workQueue?id={workQueueId}
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| id | Required | Unique identifier of the work queue. | String |
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'{"data":[],"errors":[{"id":"699c3307440ba77b14af2a86","code":404,"message":"Work queue not found. Verify the work queue exists and you have access permissions."}]}| Parameter | Sub-parameter | Description | Type |
|---|---|---|---|
| data | Contains returned work queue details. | Array<Object> | |
| data | id | Unique work queue identifier. | String |
| workQueueName | Work queue name. | String | |
| workQueueType | Work queue type. | String | |
| useUnifiedRouting | Indicates whether unified routing is enabled. | Boolean | |
| assignmentProvider | Assignment provider. | String | |
| routingStrategy | Routing strategy. | String | |
| userGroups | Associated user-group IDs. | Array<String> | |
| users | Associated user IDs. | Array<String> | |
| availableStatuses | Eligible agent statuses. | Array<String> | |
| stickinessTimeout | Stickiness timeout. | Long | |
| capacity | Queue capacity. | Integer | |
| routingEvaluationMethod | Routing evaluation method. | String | |
| additional | Additional timeout-unit settings. | Object | |
| shareConfigs | Sharing configurations. | Array<Object> | |
| voiceConfigEnabled | Indicates whether voice is enabled. | Boolean | |
| errors | Contains processing errors. | Array<Object> | |
| errors | id | Error identifier. | String |
| code | Error code. | Integer | |
| message | Error description. | String |
Fetches a single matching work queue.
GET /api/v3/workQueue?id={workQueueId}
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| id | Required | Unique identifier of the work queue. | String |
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'{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}| Parameter | Sub-parameter | Description | Type |
|---|---|---|---|
| data | Contains returned work queue details. | Array<Object> | |
| data | id | Unique work queue identifier. | String |
| workQueueName | Work queue name. | String | |
| workQueueType | Work queue type. | String | |
| useUnifiedRouting | Indicates whether unified routing is enabled. | Boolean | |
| assignmentProvider | Assignment provider. | String | |
| routingStrategy | Routing strategy. | String | |
| userGroups | Associated user-group IDs. | Array<String> | |
| users | Associated user IDs. | Array<String> | |
| availableStatuses | Eligible agent statuses. | Array<String> | |
| stickinessTimeout | Stickiness timeout. | Long | |
| capacity | Queue capacity. | Integer | |
| routingEvaluationMethod | Routing evaluation method. | String | |
| additional | Additional timeout-unit settings. | Object | |
| shareConfigs | Sharing configurations. | Array<Object> | |
| voiceConfigEnabled | Indicates whether voice is enabled. | Boolean | |
| errors | Contains processing errors. | Array<Object> | |
| errors | id | Error identifier. | String |
| code | Error code. | Integer | |
| message | Error description. | String |
Fetches work queues using one or more exact names.
GET /api/v3/workQueue?name={workQueueName}
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| name | Required | Exact work queue name or comma-separated list of exact names. | String |
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'{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}| Parameter | Sub-parameter | Description | Type |
|---|---|---|---|
| data | Contains returned work queue details. | Array<Object> | |
| data | id | Unique work queue identifier. | String |
| workQueueName | Work queue name. | String | |
| workQueueType | Work queue type. | String | |
| useUnifiedRouting | Indicates whether unified routing is enabled. | Boolean | |
| assignmentProvider | Assignment provider. | String | |
| routingStrategy | Routing strategy. | String | |
| userGroups | Associated user-group IDs. | Array<String> | |
| users | Associated user IDs. | Array<String> | |
| availableStatuses | Eligible agent statuses. | Array<String> | |
| stickinessTimeout | Stickiness timeout. | Long | |
| capacity | Queue capacity. | Integer | |
| routingEvaluationMethod | Routing evaluation method. | String | |
| additional | Additional timeout-unit settings. | Object | |
| shareConfigs | Sharing configurations. | Array<Object> | |
| voiceConfigEnabled | Indicates whether voice is enabled. | Boolean | |
| errors | Contains processing errors. | Array<Object> | |
| errors | id | Error identifier. | String |
| code | Error code. | Integer | |
| message | Error description. | String |
Fetches agent, wait-time, backlog, business-hours, and assignment statistics.
GET /api/v3/workQueue/workQueueStats?workQueueId={workQueueId}
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| workQueueId | Required | Unique identifier of the work queue. | String |
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'{"data":{"numberOfAvailableAgents":0,"numberOfIdleAgents":0,"numberOfLoggedInAgents":0,"maxIdleAgentTime":0,"estimatedWaitTimeMillis":0,"averageWaitTimeMillis":0,"oldestCustomerWaitTime":0,"currentBackLog":0,"businessHourStartTime":1786446000000,"businessHourEndTime":1786500000000,"canAssignNewCase":false},"errors":[]}| Parameter | Description | Type |
|---|---|---|
| data | Contains work queue statistics. | Object |
| numberOfAvailableAgents | Number of available agents. | Integer |
| numberOfIdleAgents | Number of idle agents. | Integer |
| numberOfLoggedInAgents | Number of logged-in agents. | Integer |
| maxIdleAgentTime | Maximum agent idle time. | Long |
| estimatedWaitTimeMillis | Estimated wait time; -1 means unavailable. | Long |
| averageWaitTimeMillis | Average wait time. | Long |
| oldestCustomerWaitTime | Oldest customer wait time. | Long |
| currentBackLog | Current backlog. | Integer |
| businessHourStartTime | Business-hours start time. | Epoch |
| businessHourEndTime | Business-hours end time. | Epoch |
| canAssignNewCase | Indicates whether a case can be assigned. | Boolean |
| errors | Contains processing errors. | Array |
Fetches work queue statistics using skill, proficiency, priority, and channel criteria.
POST /api/v3/workQueue/workQueueStatsSkillBased
| Parameter | Sub-parameter | Required/Optional | Description | Type |
|---|---|---|---|---|
| workQueueId | Required | Work queue identifier. | String | |
| skillNameVsProficiency | Required | Maps skills to minimum proficiency values. | Object | |
| skillName | Required | Skill name used as a dynamic key. | String | |
| proficiency | Required | Minimum proficiency value. | Integer | |
| priority | Required | Assignment priority. | Integer | |
| channelForAssignmentCheck | Required | Channel evaluated for assignment. | String |
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"}'{"data":{"numberOfAvailableAgents":0,"numberOfIdleAgents":0,"numberOfLoggedInAgents":0,"maxIdleAgentTime":0,"estimatedWaitTimeMillis":0,"averageWaitTimeMillis":0,"oldestCustomerWaitTime":0,"currentBackLog":0,"businessHourStartTime":1786446000000,"businessHourEndTime":1786500000000,"canAssignNewCase":false},"errors":[]}| Parameter | Description | Type |
|---|---|---|
| data | Contains work queue statistics. | Object |
| numberOfAvailableAgents | Number of available agents. | Integer |
| numberOfIdleAgents | Number of idle agents. | Integer |
| numberOfLoggedInAgents | Number of logged-in agents. | Integer |
| maxIdleAgentTime | Maximum agent idle time. | Long |
| estimatedWaitTimeMillis | Estimated wait time; -1 means unavailable. | Long |
| averageWaitTimeMillis | Average wait time. | Long |
| oldestCustomerWaitTime | Oldest customer wait time. | Long |
| currentBackLog | Current backlog. | Integer |
| businessHourStartTime | Business-hours start time. | Epoch |
| businessHourEndTime | Business-hours end time. | Epoch |
| canAssignNewCase | Indicates whether a case can be assigned. | Boolean |
| errors | Contains processing errors. | Array |
Fetches multiple matching work queues by ID.
GET /api/v3/workQueue?id={workQueueId1},{workQueueId2}
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| id | Required | Comma-separated list of work queue identifiers. | String |
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'{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}| Parameter | Sub-parameter | Description | Type |
|---|---|---|---|
| data | Contains returned work queue details. | Array<Object> | |
| data | id | Unique work queue identifier. | String |
| workQueueName | Work queue name. | String | |
| workQueueType | Work queue type. | String | |
| useUnifiedRouting | Indicates whether unified routing is enabled. | Boolean | |
| assignmentProvider | Assignment provider. | String | |
| routingStrategy | Routing strategy. | String | |
| userGroups | Associated user-group IDs. | Array<String> | |
| users | Associated user IDs. | Array<String> | |
| availableStatuses | Eligible agent statuses. | Array<String> | |
| stickinessTimeout | Stickiness timeout. | Long | |
| capacity | Queue capacity. | Integer | |
| routingEvaluationMethod | Routing evaluation method. | String | |
| additional | Additional timeout-unit settings. | Object | |
| shareConfigs | Sharing configurations. | Array<Object> | |
| voiceConfigEnabled | Indicates whether voice is enabled. | Boolean | |
| errors | Contains processing errors. | Array<Object> | |
| errors | id | Error identifier. | String |
| code | Error code. | Integer | |
| message | Error description. | String |
Fetches work queues accessible to the authenticated user.
GET /api/v3/workQueue/workQueuesByUser
This API does not require query parameters.
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'{"data":[{"id":"698b10b8d4fc1f5d4a4368fb","workQueueName":"Test-queue-Dinesh","workQueueType":"UNIVERSAL_CASE","assignmentProvider":"SPRINKLR","routingStrategy":"SKILL_BASED_ROUTING","routingEvaluationMethod":"ROUND_ROBIN","voiceConfigEnabled":true}],"errors":[]}| Parameter | Sub-parameter | Description | Type |
|---|---|---|---|
| data | Contains returned work queue details. | Array<Object> | |
| data | id | Unique work queue identifier. | String |
| workQueueName | Work queue name. | String | |
| workQueueType | Work queue type. | String | |
| useUnifiedRouting | Indicates whether unified routing is enabled. | Boolean | |
| assignmentProvider | Assignment provider. | String | |
| routingStrategy | Routing strategy. | String | |
| userGroups | Associated user-group IDs. | Array<String> | |
| users | Associated user IDs. | Array<String> | |
| availableStatuses | Eligible agent statuses. | Array<String> | |
| stickinessTimeout | Stickiness timeout. | Long | |
| capacity | Queue capacity. | Integer | |
| routingEvaluationMethod | Routing evaluation method. | String | |
| additional | Additional timeout-unit settings. | Object | |
| shareConfigs | Sharing configurations. | Array<Object> | |
| voiceConfigEnabled | Indicates whether voice is enabled. | Boolean | |
| errors | Contains processing errors. | Array<Object> | |
| errors | id | Error identifier. | String |
| code | Error code. | Integer | |
| message | Error description. | String |
Fetches skill-based work queue statistics using assignment criteria.
POST /api/v3/workQueue/workQueueStatsSkillBased
| Parameter | Sub-parameter | Required/Optional | Description | Type |
|---|---|---|---|---|
| workQueueId | Required | Work queue identifier. | String | |
| skillNameVsProficiency | Required | Maps skills to minimum proficiency values. | Object | |
| skillName | Required | Skill name used as a dynamic key. | String | |
| proficiency | Required | Minimum proficiency value. | Integer | |
| priority | Required | Assignment priority. | Integer | |
| channelForAssignmentCheck | Required | Channel evaluated for assignment. | String |
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"}'{"data":{"numberOfAvailableAgents":0,"numberOfIdleAgents":0,"numberOfLoggedInAgents":0,"maxIdleAgentTime":0,"estimatedWaitTimeMillis":0,"averageWaitTimeMillis":0,"oldestCustomerWaitTime":0,"currentBackLog":0,"businessHourStartTime":1786446000000,"businessHourEndTime":1786500000000,"canAssignNewCase":false},"errors":[]}| Parameter | Description | Type |
|---|---|---|
| data | Contains work queue statistics. | Object |
| numberOfAvailableAgents | Number of available agents. | Integer |
| numberOfIdleAgents | Number of idle agents. | Integer |
| numberOfLoggedInAgents | Number of logged-in agents. | Integer |
| maxIdleAgentTime | Maximum agent idle time. | Long |
| estimatedWaitTimeMillis | Estimated wait time; -1 means unavailable. | Long |
| averageWaitTimeMillis | Average wait time. | Long |
| oldestCustomerWaitTime | Oldest customer wait time. | Long |
| currentBackLog | Current backlog. | Integer |
| businessHourStartTime | Business-hours start time. | Epoch |
| businessHourEndTime | Business-hours end time. | Epoch |
| canAssignNewCase | Indicates whether a case can be assigned. | Boolean |
| errors | Contains processing errors. | Array |
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
dataarray, 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
dataobject 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.
- Send
POST /api/v3/workQueuewith the required configuration. - Save
data.idfrom the response. - Fetch the queue with
GET /api/v3/workQueue?id={id}. - Compare the returned configuration with the create response.
- Treat the fetched object as the authoritative stored state.
- URL-encode each exact queue name.
- Send the names through the
namequery parameter. - Read the matching objects from
data. - Store and use the returned
idvalues for subsequent statistics calls. - Handle zero or multiple matches instead of assuming exactly one result.
- Send comma-separated queue IDs.
- Process every object in
data. - Process every entry in
errors. - Correlate successful objects by their queue
id. - Do not retry the entire batch only because one item failed.
- Use
workQueueStatsfor queue-level assignment availability. - Use
workQueueStatsSkillBasedwhen eligibility depends on required skills, proficiency, priority, or channel. - Check
canAssignNewCasedirectly. - Use backlog and wait-time values for operational context, not as substitutes for
canAssignNewCase.
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