API

Obtener la lista de usuarios o un usuario

GET/api/crm/v2/teamv2
operationId: team.default

Sin id, devuelve una lista paginada de usuarios con registros abreviados. Con id, se retorna el registro completo del usuario en data.list[0], sin paginación ni filtros. El modo (partner o affiliate) lo define el servidor según la sesión. El filtro por rol (permission_role_id) y la búsqueda por nombre (name) son opcionales.

Autorización

api-token + language + role

Parámetros de consulta

idinteger

Si se proporciona, se devuelve un solo registro completo sin paginación

Ejemplo: 1

permission_role_idinteger

Ejemplo: 1

namestring

Todos los modos; subcadena del nombre de usuario (nombre y apellido) sin distinguir mayúsculas de minúsculas

Ejemplo: Alina

page_numberinteger

Ejemplo: 1

Respuestas

OK

object
statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of object
valuestringobligatorio

Ejemplo: example

namestringobligatorio

Ejemplo: All

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

account_idobject (FilterSelectInteger)
valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object
valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

affiliate_idobject (FilterSelectInteger)
valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object
valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

permission_role_idobject (FilterSelectInteger)
valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object
valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

nameobject (FilterInput)
valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: integer or string

placeholderstring

Ejemplo: string

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

listarray of oneOf
oneOf
Una de las opciones
object (PermissionRoleUserPartner)

Usuario en modo partner

idintegerobligatorio

Ejemplo: 1

namestring

Ejemplo: John Doe

emailstring

Ejemplo: user@example.com

photostring

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

permission_rolesarray of objectobligatorio

Todos los roles de usuario, ordenados por id del rol

idintegerobligatorio

Ejemplo: 5

namestringobligatorio

Nombre del rol del directorio de roles; el conjunto de valores es abierto

Ejemplo: head_of_sales

blockedbooleanobligatorio

Estado del interruptor de bloqueo

Ejemplo: false

phone_format_idinteger (PhoneFormatId)

Código de país: 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)

Ejemplo: 1

phone_numberstring

Ejemplo: 9999999999

date_creationstring (DataTimeFormatSQL)

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

bound_settingsarray of string

Configuraciones relacionadas con el usuario para advertencia al eliminar; null si no existen

can_toggle_blockbooleanobligatorio

El interruptor de bloqueo está disponible en esta fila para el usuario actual; la regla la determina el servidor, no la infiera a partir de los nombres de los roles

Ejemplo: true

can_manage_sessionsbooleanobligatorio

El usuario actual puede ver y cerrar las sesiones de esta línea

Ejemplo: false

paginationobject (Pagination)
max_countintegerobligatorio

Cantidad de elementos por página

Ejemplo: 30

page_numberintegerobligatorio

Número de la página actual; limitado para que el desplazamiento no supere 1000

Ejemplo: 1

has_nextbooleanobligatorio

¿Hay una página siguiente?

Ejemplo: true

has_previousbooleanobligatorio

¿Hay una página anterior?

Ejemplo: false