Get a list of users or a single user

GET/api/crm/v2/teamv2

operationId: team.default

Without id, returns a paginated list of users with truncated records. With id, returns the full user record in data.list[0], without pagination or filters. The mode (partner or affiliate) is set by the server based on the session. Filtering by role (permission_role_id) and searching by name (name) are optional.

Authorization

api-token + language + role

Query parameters

idinteger

If provided, returns a single complete record without pagination

Example: 1

permission_role_idinteger

Example: 1

namestring

All modes; case-insensitive substring of the user's name (first and last name)

Example: Alina

page_numberinteger

Example: 1

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobject

modeobject (FilterSelect)

valuestring

Example: example

typestringrequired

Example: select

optionarray of object

valuestringrequired

Example: example

namestringrequired

Example: All

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

account_idobject (FilterSelectInteger)

valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object

valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

Values:force_shownvalue_required

Example: value_required

affiliate_idobject (FilterSelectInteger)

valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object

valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

Values:force_shownvalue_required

Example: value_required

permission_role_idobject (FilterSelectInteger)

valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object

valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

Values:force_shownvalue_required

Example: value_required

nameobject (FilterInput)

valuestring

Example: example

typestringrequired

Example: integer or string

placeholderstring

Example: string

modestring (FilterMode)

Values:force_shownvalue_required

Example: value_required

listarray of oneOf

oneOf

One of the options

object (PermissionRoleUserPartner)

User in partner mode

idintegerrequired

Example: 1

namestring

Example: John Doe

emailstring

Example: user@example.com

photostring

Example: data:image/jpeg;base64,/9j/4AAQSkZJRg...

permission_rolesarray of objectrequired

All user roles, sorted by role id

idintegerrequired

Example: 5

namestringrequired

Role name from the roles directory; value set is open

Example: head_of_sales

blockedbooleanrequired

Lock toggle state

Example: false

phone_format_idinteger (PhoneFormatId)

Country code: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Example: 1

phone_numberstring

Example: 9999999999

date_creationstring (DataTimeFormatSQL)

Example: 2024-05-02 08:31:16

bound_settingsarray of string

User-related settings for deletion warning; null if none

can_toggle_blockbooleanrequired

The block toggle is available in this row to the current user; the rule is determined by the server, do not infer it from role names

Example: true

can_manage_sessionsbooleanrequired

The current user can view and close sessions of this row

Example: false

object (PermissionRoleUserAffiliate)

User in affiliate mode

idintegerrequired

Example: 1

namestringcan be null

Example: John Doe

entity_name_fullstring

Example: LLC Green Basket

emailstringrequired

Example: user@example.com

photostring

Example: data:image/jpeg;base64,/9j/4AAQSkZJRg...

permission_rolesarray of objectrequired

All user roles, sorted by role id

idintegerrequired

Example: 5

namestringrequired

Role name from the roles directory; value set is open

Example: head_of_sales

blockedbooleanrequired

Example: false

phone_format_idinteger (PhoneFormatId)

Example: 1

phone_numberstring

Example: 9666666666

zonestring

Example: ru

is_current_userboolean

The record belongs to the current affiliate user. An affiliate can change their own email and password only.

Example: false

can_toggle_blockbooleanrequired

The block toggle is available in this row to the current user; the rule is determined by the server, do not infer it from role names

Example: true

can_manage_sessionsbooleanrequired

The current user can view and close sessions of this row

Example: false

object (TeamUserPartnerFull)

Mode partner, full user record (GET /team?id=)

idintegerrequired

Example: 1

blockedbooleanrequired

Example: false

date_creationstring (DataTimeFormatSQL)

Example: 2024-05-02 08:31:16

namestringcan be null

Example: John Smith

photostringcan be null

Example: data:image/jpeg;base64,/9j/4AAQSkZJRg...

emailstringrequired

Example: operator@fs.pro

phone_format_idinteger (PhoneFormatId)

Example: 1

phone_numberstring

Example: 9999999999

telegram_user_idstringcan be null

Example: 476962294

otp_enabledboolean

Example: false

timezonestring

Example: Europe/Kaliningrad

languagestring

Example: ru

permission_rolesarray of objectrequired

All user roles, sorted by role id

idintegerrequired

Example: 5

namestringrequired

Role name from the roles directory; value set is open

Example: head_of_sales

bound_settingsarray of stringcan be null

can_toggle_blockbooleanrequired

The block toggle is available in this row to the current user; the rule is determined by the server, do not infer it from role names

Example: true

can_manage_sessionsbooleanrequired

The current user can view and close sessions of this entry

Example: false

object (TeamUserAffiliateFull)

affiliate mode, full user record (GET /team?id=)

idintegerrequired

Example: 1

blockedbooleanrequired

Example: false

entity_name_fullstring

Example: LLC Green Basket

namestringcan be null

Example: John Smith

photostringcan be null

Example: data:image/jpeg;base64,/9j/4AAQSkZJRg...

emailstringrequired

Example: Ivanov@gmail.com

phone_format_idinteger (PhoneFormatId)

Example: 1

phone_numberstring

Example: 9666666666

telegram_user_idstringcan be null

Example: 476962294

zonestring

Example: ru

is_current_userboolean

The record belongs to the current affiliate user

Example: false

permission_rolesarray of objectrequired

All user roles, sorted by role id

idintegerrequired

Example: 5

namestringrequired

Role name from the roles directory; value set is open

Example: head_of_sales

can_toggle_blockbooleanrequired

The block toggle is available in this row to the current user; the rule is determined by the server, do not infer it from role names

Example: true

can_manage_sessionsbooleanrequired

The current user can view and close sessions of this entry

Example: false

paginationobject (Pagination)

max_countintegerrequired

Number of items per page

Example: 30

page_numberintegerrequired

Current page number; limited so that the offset does not exceed 1000

Example: 1

has_nextbooleanrequired

Is there a next page

Example: true

has_previousbooleanrequired

Is there a previous page

Example: false