API

Obter a lista de usuários ou um usuário específico

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

Sem id, retorna uma lista paginada de usuários com registros resumidos. Com id, retorna o registro completo do usuário em data.list[0], sem paginação ou filtros. O modo (partner ou affiliate) é definido pelo servidor conforme a sessão. O filtro por função (permission_role_id) e a busca por nome (name) são opcionais.

Autorização

api-token + language + role

Parâmetros de consulta

idinteger

Se fornecido, retorna um único registro completo sem paginação

Exemplo: 1

permission_role_idinteger

Exemplo: 1

namestring

Todos os modos; substring do nome de usuário (nome e sobrenome), sem diferenciar maiúsculas de minúsculas

Exemplo: Alina

page_numberinteger

Exemplo: 1

Respostas

OK

object
statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of object
valuestringobrigatório

Exemplo: example

namestringobrigatório

Exemplo: All

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

account_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

affiliate_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

permission_role_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

nameobject (FilterInput)
valuestring

Exemplo: example

typestringobrigatório

Exemplo: integer or string

placeholderstring

Exemplo: string

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

listarray of oneOf
oneOf
Uma das opções
object (PermissionRoleUserPartner)

Usuário no modo partner

idintegerobrigatório

Exemplo: 1

namestring

Exemplo: John Doe

emailstring

Exemplo: user@example.com

photostring

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

permission_rolesarray of objectobrigatório

Todos os papéis do usuário, ordenados por id do papel

idintegerobrigatório

Exemplo: 5

namestringobrigatório

Nome do cargo do diretório de cargos; conjunto de valores aberto

Exemplo: head_of_sales

blockedbooleanobrigatório

Estado do interruptor de bloqueio

Exemplo: false

phone_format_idinteger (PhoneFormatId)

Código do 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)

Exemplo: 1

phone_numberstring

Exemplo: 9999999999

date_creationstring (DataTimeFormatSQL)

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

bound_settingsarray of string

Configurações relacionadas ao usuário para aviso ao excluir; null se não houver

can_toggle_blockbooleanobrigatório

O alternador de bloqueio está disponível nesta linha para o usuário atual; a regra é definida pelo servidor, não deduza a partir dos nomes dos papéis

Exemplo: true

can_manage_sessionsbooleanobrigatório

O usuário atual pode visualizar e encerrar as sessões desta linha

Exemplo: false

paginationobject (Pagination)
max_countintegerobrigatório

Número de itens por página

Exemplo: 30

page_numberintegerobrigatório

Número da página atual; limitado para que o deslocamento não exceda 1000

Exemplo: 1

has_nextbooleanobrigatório

Existe uma próxima página

Exemplo: true

has_previousbooleanobrigatório

Existe uma página anterior

Exemplo: false