Listar serviços

GEThttps://carchost.fieldcontrol.com.br/work-services

Lista os serviços da conta, com paginação e filtros. A listagem é ordenada pelo identificador.

Requer os headers X-Api-Key e User-Agent. Limite: 1 requisição por segundo (saiba mais).

Requisição

Parâmetros de consulta

limitinteger

Quantidade de itens por página.

De 1 a 100.Padrão: 10.

offsetinteger

Quantidade de itens a pular.

De 0 a 200000.Padrão: 0.

qstring

Filtros no formato campo:valor, separados por espaço (como filtrar). Os filtros aceitos estão na tabela abaixo.

Exemplo: name:higieniza archived:false.

Filtro	O que faz
name	Parte do nome do serviço, sem diferenciar maiúsculas e minúsculas. Até 50 caracteres.
external_id	Identificador do serviço no seu sistema (external.id), exatamente igual ao cadastrado.
archived	true para arquivados, false para ativos.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Respostas

• 200

  Lista de serviços.

• 401

  Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

• 403

  Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

• 422

  Filtro ou paginação inválidos (parametersValidationErr).

• 429

  Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

• 500

  Erro inesperado no servidor.