Create

POST

/api/v1/users

Creates a user (agent) in your workspace. The account is usable immediately — the person does not need to be invited or to log in first, which is the point of this endpoint.

roleIds must contain at least one role ID from Role → Listing. An unrecognised ID is rejected with 422, so fetch the list once and cache it.

The account becomes loginable a moment after this call returns. The response is 201 as soon as the user is stored, while the sign-in directory is updated asynchronously. In practice this is a second or two. If a caller reports that a brand-new account cannot sign in, re-read it with Detail and retry the login rather than creating the user again.

An email address must be unique across all of klink.cloud, not just your workspace. Reusing one returns 422.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Examples

Responses

🟢201

application/json

Bodyapplication/json

🟠401Unauthorized

🟠429Too Many Requests

🟠422Unprocessable Entity

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://apigw.klinkcx.com/api/v1/users' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "email": "string",
    "password": "string",
    "roleIds": [
        "string"
    ],
    "phone": "string",
    "address": "string",
    "globalAgentCapacity": 0
}'

Response Example

201 - Example 1

{
    "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"
    }
}

Modified at 2026-08-10 03:17:15

Get Telephony CDR

Listing