Listing

GET/api/v1/queues

Returns every automation queue in your workspace, each with its full member list. This endpoint is not paginated.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

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

Responses

200

requestIdstringrequired
Unique ID for this request. Quote it when reporting a problem.
dataarray[object]required
Child attributes
- idstringrequired
- namestringrequired
- descriptionstring | nullrequired
- emojistringrequired
- distributionStrategystring | nullrequired
  Allowed values:"round-robin", "fewest-assignments", "random", "notify-all", null
- maximumAssignPerAgentinteger | nullrequired
- useGlobalAgentCapacitybooleanrequired
- offlineAssignmentbooleanrequired
- autoAssignboolean | nullrequired
- membersarray[object]required
  Child attributes
  userIdstringrequired
  namestringrequired
  emailstringrequired
  membershipRolestringrequired
  agent receives conversations from the queue; manager supervises it.
  
  Allowed values:"agent", "manager"
- createdAtstringrequired
- updatedAtstringrequired

401

Unauthorized

messagestringrequired

429

Too Many Requests

messagestringrequired

Request

curl -X GET "https://apigw.klinkcx.com/api/v1/queues" \
  -H "Authorization: Bearer {token}"

Response

{
  "requestId": "string",
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "emoji": "string",
      "distributionStrategy": "round-robin",
      "maximumAssignPerAgent": 0,
      "useGlobalAgentCapacity": true,
      "offlineAssignment": true,
      "autoAssign": true,
      "members": [
        {
          "userId": "string",
          "name": "string",
          "email": "string",
          "membershipRole": "agent"
        }
      ],
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}