Listar Artigos

Permite listar os artigos cadastrados na Base de Conhecimento por meio da API do TomTicket.

Endpoint

MétodoRotaContent-Type
GEThttps://api.tomticket.com/v2.0/kb/article/listform-data

Autenticação

Este endpoint utiliza autenticação Bearer Token.

Authorization: Bearer SEU_TOKEN_AQUI

Caso 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

CampoTipoObrigatórioTamanho máximoDescrição
pageintegerNão-Índice da página desejada para o resultado.
category_idstringNão-Hash identificador da categoria desejada.

JSON de saída

JSON de saída - Listar Artigos

CampoTipoDescrição
errorbooleanInforma 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.
messagestringDetalhes da operação, caso tenha ocorrido ou não um problema.
successbooleanInforma se tudo ocorreu com sucesso.
sizeintegerTotal de itens encontrados.
pagesintegerTotal de páginas disponíveis para consulta.
next_pageintegerPróxima página disponível para navegação. Retorna null caso não haja.
previous_pageintegerPágina anterior para navegação. Retorna null caso não haja.
dataarrayLista de artigos retornados na consulta.
idstringIdentificador do artigo.
titlestringTítulo do artigo.
urlstringURL do artigo.
categoryobjectDados da categoria do artigo.
idstringIdentificador da categoria.
namestringNome da categoria.
urlstringURL da categoria.
primaryobjectCategoria pai, se houver.
idstringIdentificador da categoria pai, se houver.
namestringNome da categoria pai.
urlstringURL da categoria pai.

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