Permite listar os artigos cadastrados na Base de Conhecimento por meio da API do TomTicket.
Endpoint
| Método | Rota | Content-Type |
|---|---|---|
GET | https://api.tomticket.com/v2.0/kb/article/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 Artigos
| Campo | Tipo | Obrigatório | Tamanho máximo | Descrição |
|---|---|---|---|---|
page | integer | Não | - | Índice da página desejada para o resultado. |
category_id | string | Não | - | Hash identificador da categoria desejada. |
JSON de saída
JSON de saída - Listar Artigos
| Campo | Tipo | Descrição |
|---|---|---|
error | boolean | Informa se ocorreu um erro na operação. Se false, a operação ocorreu com sucesso; se true, 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 | Informa se tudo ocorreu 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. Retorna null caso não haja. |
previous_page | integer | Página anterior para navegação. Retorna null caso não haja. |
data | array | Lista de artigos retornados na consulta. |
id | string | Identificador do artigo. |
title | string | Título do artigo. |
url | string | URL do artigo. |
category | object | Dados da categoria do artigo. |
id | string | Identificador da categoria. |
name | string | Nome da categoria. |
url | string | URL da categoria. |
primary | object | Categoria pai, se houver. |
id | string | Identificador da categoria pai, se houver. |
name | string | Nome da categoria pai. |
url | string | URL da categoria pai. |