Clickfin

Referência da API
Portal oficial
GET/service

Listar serviços de uma empresa

Retorna uma lista paginada dos serviços não excluídos da empresa selecionada no token, ordenada pelo texto do item da Lista de Serviços (serviceItem.text) e depois por _id. Disponível para qualquer perfil da empresa (não exige perfil de Administrador).

AcessoChave de API · services:read
Parâmetros3
Respostas6

Parâmetros

  • pagequery

    Número da página para a paginação. Precisa ser inteiro: um valor decimal (por exemplo `1.5`) responde 400.

  • limitquery

    Quantidade de itens por página. Precisa ser inteiro: um valor decimal responde 400.

  • statusquery

    Filtra os serviços pelo status (0 = inativo, 1 = ativo). Sem o filtro, retorna os serviços de qualquer status, inclusive os registros mais antigos gravados com `status: null`. Outro valor responde 400.

Respostas

200Sucesso

Lista de serviços retornada com sucesso.

400Erro

Parâmetro de consulta inválido ou empresa não selecionada no token.

401Erro

Token ausente, inválido ou expirado, ou empresa do token fora do licenciado (SERVICE.LIST.NOT_AUTHORIZED).

403Erro

Acesso comercial do licenciado bloqueado.

429Erro

Limite de requisições excedido (RATE_LIMIT.EXCEEDED). Por chave: 120 requisições por minuto (janela fixa de 60 s); o 429 da chave traz X-RateLimit-* da chave. Por IP, para tráfego com chave: 600 requisições em 10 minutos; esse 429 traz só Retry-After, sem X-RateLimit-* (os cabeçalhos descrevem apenas o limite da chave). Aguarde Retry-After segundos antes de tentar de novo.

503Erro

Credencial não pôde ser verificada por falha temporária do servidor (AUTH.SESSION_UNAVAILABLE). Não invalida a chave nem a sessão: repita com backoff.