

Este método permite listar todas as categorias de artigos da sua conta.
Endpoint
| Método | Rota | Content-Type |
|---|---|---|
GET | https://api.tomticket.com/v2.0/kb/category/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 - Listar Categoria de Artigo
| Campo | Tipo | Obrigatório | Tamanho máximo | Descrição |
|---|---|---|---|---|
page | integer | Não | - | O índice da página desejado para o resultado. |
JSON de saída
JSON de saída - Listar Categoria de Artigo
| 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 mensagem 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 | integer | Próxima página disponível para navegação. Retornará NULL caso não houver. |
previous_page | integer | Página anterior para navegação. Retornará NULL caso não houver. |
data | array | Lista com as categorias cadastradas. |
id | string | Identificador da categoria. |
name | string | Nome da categoria. |
url | string | URL pública do domínio da conta + URL amigável para acesso. |
child | array | Categorias filhas. |
id | string | Identificador da categoria. |
name | string | Nome da categoria. |
url | string | URL pública do domínio da conta + URL amigável para acesso. |
Possíveis erros
| Status HTTP | Mensagem | Quando ocorre |
|---|---|---|
| 200 | Operação realizada com sucesso. | Quando a consulta é concluída 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. |