klink-developers-logo

Automation Queue

Detail

GET/api/v1/queues/{id}

Returns a single queue with its members and routing settings.

Request

Authorization

Bearer Token

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

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

Path Params
  • idstringrequired

    Queue ID.

    Example:

Responses

200

OK

  • requestIdstringrequired

    Unique ID for this request. Quote it when reporting a problem.

  • dataobjectrequired
    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
404

Not Found

  • messagestringrequired
429

Too Many Requests

  • messagestringrequired