Este método permite listar todas as suas organizações.
A consulta de organizações exibe 50 itens por página, sendo necessário navegar entre as páginas para consultar outros resultados.
Endpoint
| Método | Rota | Content-Type |
|---|---|---|
GET | https://api.tomticket.com/v2.0/organization/list | form-data |
Autenticação
Este endpoint utiliza autenticação Bearer Token.
Authorization: Bearer SEU_TOKEN_AQUICaso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso.
Parâmetros da requisição
Parâmetros da requisição - Consultar Organizações
| Campo | Tipo | Obrigatório | Tamanho máximo | Descrição |
|---|---|---|---|---|
page | integer | Não | - | Índice da página que deseja acessar. São exibidos 50 itens a cada página. |
column | string | Não | 20 | Coluna usada para ordenação dos resultados. Podem ser usadas as opções name, email e creation_date. |
order | string | Não | 4 | Modo de ordenação das colunas, podendo ser crescente ASC ou decrescente DESC. |
show_custom_fields | integer | Não | - | Define se os campos personalizados do cadastro da organização serão exibidos. Valores disponíveis: 0 para não exibir e 1 para exibir. |
organization_mother_id | string | Não | 512 | Permite pesquisar organizações filiais por um identificador da organização matriz. |
JSON de saída
JSON de saída - Consultar Organizações
| Campo | Tipo | Descrição |
|---|---|---|
error | boolean | Informa 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 message para identificar o problema. |
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. |
pages | integer | Total de páginas disponíveis para consulta. |
next_page | Próxima página disponível para navegação. Retornará NULL caso não houver. | |
previous_page | Página anterior para navegação. Retornará NULL caso não houver. | |
data | array | Lista com as organizações cadastradas. |
id | string | Identificador da organização. |
name | string | Nome da organização. |
email | string | Endereço de e-mail da organização. |
phone | string | Telefone da organização. |
monthly_ticket_quota | integer | Cota mensal de chamados que podem ser criados pela organização. |
allow_create_tickets | boolean | Permissão para criar chamados. |
has_child | boolean | Informa se esta organização possui organizações filiais. |
active | boolean | Informa se esta organização está ativa. |
manager_permission | boolean | Informa se o gerente da organização pode ver os chamados dos clientes de sua organização no painel do cliente. |
members_permission | boolean | Informa se os membros da organização podem ver os chamados uns dos outros no painel do cliente. |
organization_mother | array | Dados da organização matriz, caso esteja vinculada a uma. |
id | string | Identificador da organização matriz. |
name | string | Nome da organização matriz. |
custom_fields | array | Campos personalizados usados no cadastro da organização. |
id | string | Identificador do campo personalizado. |
name | string | Label do campo personalizado. |
value | Valor atribuído ao campo personalizado. |
Possíveis erros
| Status HTTP | Mensagem | Quando ocorre |
|---|---|---|
| 200 | Operação realizada com sucesso. | Consulta executada com sucesso. |
| 401 | Token ou valores enviados não autorizados para uso. | Quando o token ou os valores enviados não são autorizados. |
| 403 | Recurso não disponível. | Quando o recurso não está disponível. |
| 404 | Recurso não encontrado. | Quando o recurso não é encontrado. |