Filtros e ordenação

Filtros

Use o parâmetro q no formato campo:valor. Cada endpoint lista, na Referência da API, os campos que aceita.

curl "https://carchost.fieldcontrol.com.br/customers?q=name:Padaria" \
  -H "X-Api-Key: SUA_CHAVE" \
  -H "User-Agent: MinhaIntegracao/1.0"

Para combinar filtros, separe-os por espaço (%20 na URL):

/customers?q=name:Padaria%20archived:false

Valores com espaço podem ser enviados entre aspas: q=name:"Padaria Pão Quente".

Operadores de data

Filtros de data como created_at aceitam operadores no fim do nome do campo:

Filtro	Significado
created_at:2026-10-13T14:30:00Z	Igual
created_at>=:2026-10-01	Maior ou igual
created_at<=:2026-10-31	Menor ou igual
created_at>:2026-10-01	Maior
created_at<:2026-10-31	Menor

Caracteres especiais

Os caracteres abaixo têm significado especial na URL e precisam ser substituídos pelo código de URL-encoding dentro do valor do filtro:

Caractere	Código
&	%26
#	%23
+	%2B
;	%3B

Exemplo, para buscar o cliente Roberto&Augusto:

/customers?q=name:Roberto%26Augusto

Letras acentuadas também devem ser codificadas pela sua biblioteca HTTP (ex.: João vira Jo%C3%A3o).

Ordenação

Use o parâmetro sort com um dos valores aceitos pelo endpoint. O prefixo - inverte a ordem:

Valor	Ordem
created_at	Do mais antigo para o mais recente
-created_at	Do mais recente para o mais antigo

curl "https://carchost.fieldcontrol.com.br/customers?sort=-created_at&limit=2" \
  -H "X-Api-Key: SUA_CHAVE" \
  -H "User-Agent: MinhaIntegracao/1.0"

Filtro ou ordenação inválidos retornam 422 com o código parametersValidationErr.