For AI agents: markdown of this page — /docs-content-en/entities/users/get.md documentation index — /llms.txt

Get employee

GET /v1/users/:id

Returns the employee data by ID with all fields, including user fields (UF_*).

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionEmployee ID. List: GET /v1/users
Parameterinclude (query) Typestring Requiredno DescriptionRelated data to include: department. See the "Related data" section
Parameterselect (query) Typestring Requiredno DescriptionComma-separated response fields, for example id,name,email. Without it, every field is returned. Names come from Employee fields

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/users/29" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/users/29" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/users/29', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log(`${data.name} ${data.lastName} — ${data.email}`)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/users/29', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on a successful request
Fielddata Typeobject DescriptionThe employee with all fields, including UF_* user fields. All fields — Employee fields
Fielddata._included Typeobject DescriptionRelated data. Returned only with the include parameter — see the "Related data" section
Fieldmeta.warnings Typearray DescriptionWarnings. Returned when select contains a name that is not an employee field: an element with the UNKNOWN_SELECT_FIELD code, that name in field and an explanation in message

To retrieve the employee's departments together with the record, use the include parameter in the GET request:

GET /v1/users/29?include=department

Available include: department. The result is in the _included.departments field — an array of the departments from departmentId that GET /v1/departments returns. A department from departmentId that this list does not contain is left out of the array:

JSON 
{
  "success": true,
  "data": {
    "id": 29,
    "name": "John",
    "departmentId": [1, 107],
    "_included": {
      "departments": [
        { "id": 107, "name": "Sales", "sort": 800, "parentId": 1, "headId": 1 }
      ]
    }
  }
}

More on includes: Related data.

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 29,
    "xmlId": "28936832",
    "active": true,
    "name": "John",
    "lastName": "Brown",
    "email": "john.brown@example.com",
    "lastLogin": "2026-03-30T14:39:25.000Z",
    "dateRegister": "2020-04-23T00:00:00.000Z",
    "timeZone": "UTC",
    "isOnline": false,
    "timestampX": {},
    "lastActivityDate": {},
    "personalPhoto": "https://cdn.bitrix24.com/.../photo.png",
    "departmentId": [1],
    "userType": "employee"
  }
}

Error response example

404 — employee not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "user 999999999 not found"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_ID Description:id is not a positive integer
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the user scope
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo employee with this ID was found, or the employee is deactivated and unavailable to the current key

Full list of common API errors — Errors.

Known specifics

WORK_* fields and some PERSONAL_* fields arrive in UPPER_SNAKE_CASE. WORK_COMPANY, WORK_DEPARTMENT, WORK_WWW, WORK_FAX, WORK_CITY, WORK_STATE, WORK_ZIP, WORK_COUNTRY and the like. PERSONAL_STATE, PERSONAL_ZIP, PERSONAL_COUNTRY, PERSONAL_MAILBOX, PERSONAL_NOTES arrive under their original Bitrix24 names. Bitrix24 account UF fields also keep their names. Standard fields (name, email, active, timeZone, userType, departmentId, etc.) use camelCase.

See also