Listing

GET

/api/v1/users

Returns a paginated list of the users in your workspace.

keyword matches on name and email. Search is substring-based, so kyaw finds "Kyaw Kyaw".

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Responses

🟢200

application/json

Bodyapplication/json

🟠401Unauthorized

🟠429Too Many Requests

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://apigw.klinkcx.com/api/v1/users?page=1&pageSize=10&keyword=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "page": 0,
    "pageSize": 0,
    "total": 0,
    "lastPage": 0,
    "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:26:01

Create

Detail