Listar Categoria de Artigo

PremiumEnterprise

Este método permite listar todas as categorias de artigos da sua conta.

Endpoint

MétodoRotaContent-Type
GEThttps://api.tomticket.com/v2.0/kb/category/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 Categoria de Artigo

CampoTipoObrigatórioTamanho máximoDescrição
pageintegerNão-O índice da página desejado para o resultado.

JSON de saída

JSON de saída - Listar Categoria de Artigo

CampoTipoDescrição
errorbooleanInforma 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.
messagestringDetalhes da operação, caso tenha ocorrido ou não um problema.
successbooleanRetorna true caso a operação tenha sido concluída com sucesso.
sizeintegerTotal de itens encontrados.
pagesintegerTotal de páginas disponíveis para consulta
next_pageintegerPróxima página disponível para navegação. Retornará NULL caso não houver.
previous_pageintegerPágina anterior para navegação. Retornará NULL caso não houver.
dataarrayLista com as categorias cadastradas.
idstringIdentificador da categoria.
namestringNome da categoria.
urlstringURL pública do domínio da conta + URL amigável para acesso.
childarrayCategorias filhas.
idstringIdentificador da categoria.
namestringNome da categoria.
urlstringURL pública do domínio da conta + URL amigável para acesso.

Possíveis erros

Status HTTPMensagemQuando ocorre
200Operação realizada com sucesso.Quando a consulta é concluída com sucesso.
401Token ou valores enviados não autorizados para uso.Quando o token ou os valores enviados não são autorizados.
403Recurso não disponível.Quando o recurso não está disponível.
404Recurso não encontrado.Quando o recurso não é encontrado.

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