Filtros y ordenación

Filtros

Use el parámetro q en el formato campo:valor. En la Referencia de la API, cada endpoint lista los campos que acepta.

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, sepárelos con un espacio (%20 en la URL):

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

Los valores con espacios se pueden enviar entre comillas: q=name:"Padaria Pão Quente".

Operadores de fecha

Los filtros de fecha como created_at aceptan operadores al final del nombre del campo:

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

Caracteres especiales

Los caracteres de abajo tienen un significado especial en la URL y se deben reemplazar por su código de URL-encoding dentro del valor del filtro:

Carácter	Código
&	%26
#	%23
+	%2B
;	%3B

Por ejemplo, para buscar el cliente Roberto&Augusto:

/customers?q=name:Roberto%26Augusto

Las letras con tilde también las debe codificar su biblioteca HTTP (p. ej. João pasa a Jo%C3%A3o).

Ordenación

Use el parámetro sort con uno de los valores aceptados por el endpoint. El prefijo - invierte el orden:

Valor	Orden
created_at	Del más antiguo al más reciente
-created_at	Del más reciente al más antiguo

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

Un filtro o una ordenación inválidos devuelven 422 con el código parametersValidationErr.