API

Obter diretórios para o formulário do operador

GET/api/crm/v2/operators.fieldsv2
operationId: operators.fields

Retorna diretórios para o formulário do operador: usuários da conta para vinculação (firm_user_id), níveis de acesso (permission), fusos horários (timezone) e o código ISO do idioma padrão do país atual (default_language).

Autorização

api-token + language + role

Parâmetros de consulta

branch_idintegerobrigatório

Exemplo: 8778

Respostas

OK

object
statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject
permissionobject (FilterEnum) obrigatório

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of 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

account_idinteger

ID da conta da filial selecionada

Exemplo: 3922

firm_user_idobject

Usuários da conta com flags de associação às configurações do operador e do entregador

typestring

Exemplo: select

optionarray of object
valueinteger

Exemplo: 825

namestring

Exemplo: user@fs.pro

has_operator_settingsboolean

Exemplo: false

has_courier_settingsboolean

Exemplo: false

timezoneobject (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

default_languagestring

Exemplo: ru