v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Get user by ID

This method allows to get the data of the user on the account by user’s ID

get/api/v4/users/{id}

Path parameters

idinteger required

User ID

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.

Response

200

idinteger

namestring

emailstring

langstring

Example response

{
  "id": 185848,
  "name": "John Doe",
  "email": "test@example.com",
  "lang": "en",
  "rights": {
    "leads": {
      "view": "M",
      "edit": "M",
      "add": "D",
      "delete": "M",
      "export": "M"
    },
    "contacts": {
      "view": "M",
      "edit": "M",
      "add": "D",
      "delete": "M",
      "export": "M"
    },
    "companies": {
      "view": "M",
      "edit": "M",
      "add": "D",
      "delete": "M",
      "export": "M"
    },
    "tasks": {
      "edit": "A",
      "delete": "A"
    },
    "catalog_access": true,
    "status_rights": [
      {
        "entity_type": "leads",
        "pipeline_id": 3166396,
        "status_id": 142,
        "rights": {
          "view": "D",
          "edit": "D",
          "delete": "D",
          "export": "D"
        }
      }
    ],
    "is_active": true
  },
  "_links": {
    "self": {
      "href": "https://example.kommo.com/api/v4/users/185848"
    }
  }
}