Detail

GET/api/v1/users/{id}

Returns a single user. Also the quickest way to confirm that a newly created account has finished provisioning.

Request

Authorization

Bearer Token

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

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

Path Params

idstringrequired
User ID.

Example:

Responses

200

requestIdstringrequired
Unique ID for this request. Quote it when reporting a problem.
dataobjectrequired
Child attributes
- idstringrequired
- namestringrequired
- emailstringrequired
- phonestring | nullrequired
- addressstring | nullrequired
- globalAgentCapacityinteger | nullrequired
  Maximum concurrent conversations for this agent, or null to fall back to the queue setting.
- rolesarray[object]required
  Child attributes
  idstringrequired
  Role ID. Use this in roleIds when creating or updating a user.
  
  systemNamestringrequired
  displayNamestringrequired
  descriptionstring | nullrequired
- createdAtstringrequired
- updatedAtstringrequired

401

Unauthorized

messagestringrequired

404

Not Found

messagestringrequired

429

Too Many Requests

messagestringrequired

Request

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

Response

{
  "requestId": "string",
  "data": {
    "id": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "globalAgentCapacity": 0,
    "roles": [
      {
        "id": "string",
        "systemName": "string",
        "displayName": "string",
        "description": "string"
      }
    ],
    "createdAt": "string",
    "updatedAt": "string"
  }
}