Parâmetros da requisição - Consultar Departamentos
Campo
Tipo
Obrigatório
Tamanho máximo
Descrição
show_nested_items
integer
Não
1
Se enviado com valor igual a zero (0), retorna a listagem apenas com o nome dos departamentos e seus IDs, sem itens aninhados, como categorias, status, atendentes etc. Valor padrão: 1.
JSON de saída
JSON de saída - Consultar Departamentos
Campo
Tipo
Descrição
error
boolean
Informa se ocorreu um erro na operação.
message
string
Detalhes da operação, caso tenha ocorrido ou não um problema.
success
boolean
Retorna true caso a operação tenha sido concluída com sucesso.
size
integer
Total de itens encontrados.
data
array
Lista com os departamentos cadastrados.
id
string
Identificador do departamento.
name
string
Nome do departamento.
categories
array
Lista as categorias ativas vinculadas ao departamento.
id
string
Identificador da categoria.
name
string
Nome da categoria.
custom_fields
array
Lista de campos personalizados usados em chamados.
id
string
Identificador do campo personalizado.
label
string
Label do campo personalizado.
type
integer
Informa o tipo do campo. Opções disponíveis: 1 - Campo de Texto; 2 - Área de Texto; 3 - Caixa de Opções (Input=Select, ComboBox); 4 - Opções (Input=Radio, Radio Group); 5 - Caixa de Verificação (Checkbox); 6 - Seleção Múltipla (Listbox).
options
array
Valores disponíveis do campo personalizado.
mandatory
boolean
Informa se o preenchimento do campo é obrigatório.
operation
array
Lista os tipos de operação em que este campo pode ser utilizado.
open
boolean
Informa se o campo pode ser usado para a abertura de chamados.
close
boolean
Informa se o campo pode ser usado para o encerramento de chamados.
evaluation
boolean
Informa se o campo pode ser usado para a avaliação de chamados.
status
array
Lista os status vinculados ao departamento.
id
string
Identificador do status.
name
string
Nome do status.
active
boolean
Informa se o status está ativo para uso.
operators
array
Lista os atendentes ativos vinculados ao departamento.
id
string
Identificador do atendente.
name
string
Nome do atendente.
mail_hash
string
Hash MD5 do endereço de e-mail do atendente.
general_custom_fields
array
Lista os campos personalizados vinculados ao departamento quando não há categoria selecionada.
tickets
array
Lista de campos personalizados usados em chamados.
id
string
Identificador do campo personalizado.
label
string
Label do campo personalizado.
type
integer
Informa o tipo do campo. Opções disponíveis: 1 - Campo de Texto; 2 - Área de Texto; 3 - Caixa de Opções (Input=Select, ComboBox); 4 - Opções (Input=Radio, Radio Group); 5 - Caixa de Verificação (Checkbox); 6 - Seleção Múltipla (Listbox).
options
array
Valores disponíveis do campo personalizado.
mandatory
boolean
Informa se o preenchimento do campo é obrigatório.
operation
array
Lista os tipos de operação em que este campo pode ser utilizado.
open
boolean
Informa se o campo pode ser usado para a abertura de chamados.
close
boolean
Informa se o campo pode ser usado para o encerramento de chamados.
evaluation
boolean
Informa se o campo pode ser usado para a avaliação de chamados.
chats
array
Lista de campos personalizados usados em chats.
id
string
Identificador do campo personalizado.
label
string
Label do campo personalizado.
type
integer
Informa o tipo do campo. Opções disponíveis: 1 - Campo de Texto; 2 - Área de Texto; 3 - Caixa de Opções (Input=Select, ComboBox); 4 - Opções (Input=Radio, Radio Group); 5 - Caixa de Verificação (Checkbox); 6 - Seleção Múltipla (Listbox).
options
array
Valores disponíveis do campo personalizado.
mandatory
boolean
Informa se o preenchimento do campo é obrigatório.
operation
array
Lista os tipos de operação em que este campo pode ser utilizado.
open
boolean
Informa se o campo pode ser usado para a abertura de chats.
evaluation
boolean
Informa se o campo pode ser usado para a avaliação de chats.
Possíveis erros
Status HTTP
Mensagem
Quando ocorre
401
Token ou valores enviados não autorizados para uso.
Quando o token ou os valores enviados não estão autorizados para uso.