v1
latestOpenAPI 3.1.02026-07-241630614.2 KBUsers list
This method allows to get the data of the user on the account by user’s ID
get/api/v4/users
Query parameters
withstring
This parameter takes a string which may consist of several values separated by commas. You can find 'with' parameters in the table.
pageinteger
Sample page
limitinteger
The number of the entities returned in the response of one request (limit – 250)
Response
200
Example response
{
"_total_items": 2,
"_page": 1,
"_page_count": 1,
"_links": {
"self": {
"href": "https://example.kommo.com/api/v4/users/?with=role%2Cgroup"
}
},
"_embedded": {
"users": [
{
"id": 123123,
"name": "Example user",
"email": "user@example.com",
"lang": "en",
"rights": {
"leads": {
"view": "A",
"edit": "A",
"add": "A",
"delete": "A",
"export": "A"
},
"contacts": {
"view": "A",
"edit": "A",
"add": "A",
"delete": "A",
"export": "A"
},
"companies": {
"view": "A",
"edit": "A",
"add": "A",
"delete": "A",
"export": "A"
},
"tasks": {
"edit": "A",
"delete": "A"
},
"status_rights": [
{
"entity_type": "leads",
"pipeline_id": 2194576,
"status_id": 30846277,
"rights": {
"view": "A",
"edit": "A",
"delete": "A"
}
}
],
"is_active": true
},
"_links": {
"self": {
"href": "https://example.kommo.com/api/v4/users/123123/"
}
},
"_embedded": {
"roles": [
{
"id": 3141,
"name": "Manager",
"_links": {
"self": {
"href": "https://example.kommo.com/api/v4/roles/3141"
}
}
}
],
"groups": [
{
"id": 267688,
"name": "Managers"
}
]
}
}
]
}
}