v1

latestOpenAPI 3.1.02026-07-261620662.2 KB

Lista de usuários

Este método permite obter os dados do usuário na conta pelo ID do usuário.

get/api/v4/users

Request body

withstring

Este parâmetro aceita uma string que pode consistir em vários valores separados por vírgulas. Você pode encontrar os parâmetros ‘with’ na tabela.

pageinteger

Página de exemplo

limitinteger

Número de entidades retornadas na resposta de uma solicitação (limite – 250).

Response

200

_total_itemsinteger

_pageinteger

_page_countinteger

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": "Usuário exemplo",
        "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": "Gerente",
              "_links": {
                "self": {
                  "href": "https://example.kommo.com/api/v4/roles/3141"
                }
              }
            }
          ],
          "groups": [
            {
              "id": 267688,
              "name": "Gerentes"
            }
          ]
        }
      }
    ]
  }
}