v1

latestOpenAPI 3.1.02026-07-261630686.8 KB

Lista de usuarios

Este método permite obtener los datos del usuario en la cuenta mediante el ID del usuario.

get/api/v4/users

Query parameters

withstring

Este parámetro toma una cadena que puede consistir en varios valores separados por comas. Puedes encontrar los parámetros 'with' en la tabla

pageinteger

Página de muestra

limitinteger

El número de entidades retornadas en la respuesta de una solicitud (límite: 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": "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"
            }
          ]
        }
      }
    ]
  }
}