Kommo

Users

GET
/v1/kommo/users

Retrieve Kommo users with role, group, and access information.

Filters:

  • organizationId (required)
  • integrationId (optional)
  • userId (optional)

Authorization

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Query Parameters

organizationId*string

Organization identifier (required)

integrationId?string

Integration identifier (optional)

userId?string

User identifier (optional)

page?integer

Page number for pagination (optional)

Default1
limit?integer

Number of items per page (optional, max 5000)

Rangevalue <= 5000
Default500

Response Body

Successful response

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/kommo/users?organizationId=organization_123"
{  "data": [    {      "user_id": "string",      "lang": "string",      "rights": {},      "is_admin": true,      "is_free": true,      "is_active": true,      "group_id": "string",      "role_id": "string",      "integration_id": "string",      "organization_id": "string",      "document_id": "string",      "inserted_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}