Início / API / Departamentos

Consultar Departamentos

Este método permite listar todos os departamentos de sua conta.


Endpoint

https://api.tomticket.com/v2.0/department/list

Método HTTP

GET

Content Type

form-data

Autenticação

Authorization: Bearer {SEU-TOKEN-AQUI}

Parâmetros Query String

Os parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint. Cada parâmetro e valor deve ser enviado com o nome dele e valor, separados pelo símbolo de "=", como por exemplo nomeParametro=ValorParametro. Para enviar mais de um parâmetro, deve separá-los, usando símbolo "&", como por exemplo nomeParametro1=ValorParametro1&nomeParametro2=ValorParametro2.


ChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximo
show_nested_itemsSe enviado o paramento com valor igual a zero(0) show_nested_items=0 retorna a listagem apenas com o nome dos departamentos e seus ID's, sem nenhum item aninhado, como categorias, status, atendentes, etc.
Não1Int1


Retorno

Descrição do retorno em JSON.

ColunaDescrição da ColunaTipo
errorInforma se ocorreu um erro na operação. Se o retorno for false, então significa que a operação ocorreu com sucesso e não ocorreram problemas. Caso o retorno seja true, ocorreu um erro e será necessário verificar o campo mensagem para identificar o problema.Boolean
messageDetalhes da operação, caso tenha ocorrido ou não um problema.String
successRetorna true caso a operação tenha sido concluída com sucesso.Boolean
sizeTotal de itens encontrados.Int
dataLista com os departamentos cadastrados.Array
data
id
Identificador do departamento.String
data
name
Nome do departamento.String
data
categories
Lista as categorias ativos vinculados ao departamento.Array
data
categories
    id
Identificador da categoria.String
data
categories
    name
Nome da categoria.String
data
categories
    custom_fields
Lista de campos personalizados usados em chamados.Array
data
categories
    custom_fields
        id
Identificador do campo personalizado.String
data
categories
    custom_fields
        label
Label do campo personalizado.String
data
categories
    custom_fields
        type
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, Ragio Group)
  • 5 - Caixa de Verificação (Checkbox)
  • 6 - Seleção Múltipla (Listbox)
Int
data
categories
    custom_fields
        options
Valores disponíveis do campo personalizado.Array
data
categories
    custom_fields
        mandatory
Informa se o preenchimento do campo é obrigatório.Boolean
data
categories
    custom_fields
        operation
Lista os tipos de operação em que este campo pode ser utilizado.Array
data
categories
    custom_fields
        operation
            open
Informa se o campo pode ser usado para a abertura de chamados.Boolean
data
categories
    custom_fields
        operation
            close
Informa se o campo pode ser usado para o encerramento de chamados.Boolean
data
categories
    custom_fields
        operation
            evaluation
Informa se o campo pode ser usado para a avaliação de chamados.Boolean
data
status
Lista os status vinculados ao departamento.Array
data
status
    id
Identificador do status.String
data
status
    name
Nome do status.String
data
status
    active
Informa se o status está ativo para uso.Boolean
data
operators
Lista os atendentes ativos vinculados ao departamento.Array
data
operators
    id
Identificador do atendente.String
data
operators
    name
Nome do atendente.String
data
operators
    mail_hash
Hash MD5 do endereço de email do atendente.String
data
categories
Lista as categorias ativos vinculados ao departamento.Array
data
categories
    id
Identificador da categoria.String
data
categories
    name
Nome da categoria.String
data
categories
    custom_fields
Lista de campos personalizados usados em chamados.Array
data
categories
    custom_fields
        id
Identificador do campo personalizado.String
data
categories
    custom_fields
        label
Label do campo personalizado.String
data
categories
    custom_fields
        type
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, Ragio Group)
  • 5 - Caixa de Verificação (Checkbox)
  • 6 - Seleção Múltipla (Listbox)
Int
data
categories
    custom_fields
        options
Valores disponíveis do campo personalizado.Array
data
categories
    custom_fields
        mandatory
Informa se o preenchimento do campo é obrigatório.Boolean
data
categories
    custom_fields
        operation
Lista os tipos de operação em que este campo pode ser utilizado.Array
data
categories
    custom_fields
        operation
            open
Informa se o campo pode ser usado para a abertura de chamados.Boolean
data
categories
    custom_fields
        operation
            close
Informa se o campo pode ser usado para o encerramento de chamados.Boolean
data
categories
    custom_fields
        operation
            evaluation
Informa se o campo pode ser usado para a avaliação de chamados.Boolean
data
general_custom_fields
Lista os campos pesonalizados vinculados ao departamento quando não há categoria selecionada.Array
data
general_custom_fields
    tickets
Lista de campos personalizados usados em chamados.Array
data
general_custom_fields
    tickets
        id
Identificador do campo personalizado.String
data
general_custom_fields
    tickets
        label
Label do campo personalizado.String
data
general_custom_fields
    tickets
        type
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, Ragio Group)
  • 5 - Caixa de Verificação (Checkbox)
  • 6 - Seleção Múltipla (Listbox)
Int
data
general_custom_fields
    tickets
        options
Valores disponíveis do campo personalizado.Array
data
general_custom_fields
    tickets
        mandatory
Informa se o preenchimento do campo é obrigatório.Boolean
data
general_custom_fields
    tickets
        operation
Lista os tipos de operação em que este campo pode ser utilizado.Array
data
general_custom_fields
    tickets
        operation
            open
Informa se o campo pode ser usado para a abertura de chamados.Boolean
data
general_custom_fields
    tickets
        operation
            close
Informa se o campo pode ser usado para o encerramento de chamados.Boolean
data
general_custom_fields
    tickets
        operation
            evaluation
Informa se o campo pode ser usado para a avaliação de chamados.Boolean
data
general_custom_fields
    chats
Lista de campos personalizados usados em chats.Array
data
general_custom_fields
    chats
        id
Identificador do campo personalizado.String
data
general_custom_fields
    chats
        label
Label do campo personalizado.String
data
general_custom_fields
    chats
        type
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, Ragio Group)
  • 5 - Caixa de Verificação (Checkbox)
  • 6 - Seleção Múltipla (Listbox)
Int
data
general_custom_fields
    chats
        options
Valores disponíveis do campo personalizado.Array
data
general_custom_fields
    chats
        mandatory
Informa se o preenchimento do campo é obrigatório.Boolean
data
general_custom_fields
    chats
        operation
Lista os tipos de operação em que este campo pode ser utilizado.Array
data
general_custom_fields
    chats
        operation
            open
Informa se o campo pode ser usado para a abertura de chats.Boolean
data
general_custom_fields
    chats
        operation
            evaluation
Informa se o campo pode ser usado para a avaliação de chats.Boolean

Código de Retorno

Descrição do código HTTP de retorno.

CódigoDescrição
200Operação realizada com sucesso.
401Token ou valores enviados não autorizados para uso.
403Recurso não disponível.
404Recurso não encontrado.

Disponibilidade

Recurso Premium Recurso Enterprise

Este artigo foi útil?  
Agradecemos sua avaliação.