Get

[POST] .../v1/user/get

Returns user information. Use this method to retrieve system users for administration, assignments, CRM participants, responsible-user pickers and integrations that need user profile data. The response returns paginated User rows with profile fields, group data, additional fields, seller_barcode, next_offset and total; the request body is required and supports filters, selector fields and sort_orders. The caller must have the user get permission, seller_barcode must contain only digits and start with 101 when provided and DB-version gated fields such as internal_phone and work_checked_in are available only when the account version supports them. Missing body, denied permission, invalid seller_barcode, unsupported version-gated filters, invalid filters or sorting and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of records to return. Server-side defaults and limits are controlled by server settings.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search string for fields: first_name, middle_name, last_name, main_phone and phones.
sort_orders Array of User_SortOrder Optional Output parameter sorting.

Filterable Fields

Field Type Description
active bool User flag that controls performing actions in the system.
address string
can_authorize bool User flag that controls authorization in the system.
date_of_birth string
description string
email string
first_name string
gender string User gender: None - not specified, Male - male, Female - female.
group_id int User group ID array.
id int User IDs.
internal_phone string Filter by user internal phone. Available for DB version 365+.
language_code string User language code.
last_name string
login string
main_phone string
middle_name string
phones string
seller_barcode string Seller barcode.
sex string
sub string User UUID in the unified profile.
work_checked_in bool

Sortable Fields

Field
active
address
can_authorize
date_of_birth
description
email
first_name
group.name
id
language_code
last_name
last_update
login
main_phone
middle_name
phones
sex
time_zone

Request Example

{
  "filters": [
    {
      "Field": "login",
      "Operator": "Equal",
      "Value": "ivanov"
    },
    {
      "Field": "active",
      "Operator": "Equal",
      "Value": "true"
    }
  ],
  "sort_orders": [
    {
      "column": "first_name",
      "direction": "ASC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of User Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 17,
      "first_name": "Ivan",
      "last_name": "Ivanov",
      "middle_name": "Sergeevich",
      "full_name": "Ivan Ivanov",
      "sex": "male",
      "date_of_birth": "1990-05-12",
      "address": "Main street 1",
      "main_phone": "\u002B998901234567",
      "phones": "\u002B998901234568",
      "email": "ivanov@example.com",
      "description": "Store manager",
      "login": "ivanov",
      "can_authorize": true,
      "active": true,
      "language_code": "eng",
      "internal_phone": "1201",
      "enable_hints": true,
      "system": true,
      "sub": "3f7c8b7a-52a1-4f2f-a0a2-5b7f88e92000",
      "photo_url": "https://example.com/users/17.jpg",
      "seller_barcode": "101000017",
      "last_update": 1712345600,
      "user_group": {
        "id": 3,
        "name": "Managers",
        "parent_id": 0,
        "child_count": 0,
        "last_update": 1712345600
      },
      "fields": []
    }
  ],
  "next_offset": 50,
  "total": 1
}