Filtros y query parameters¶

Visión general¶

Las variables de listado de API Pontotel soporta filtros vía query parameters Para refinar y buscar datos específicos.

Sintaxis de los filtros¶

Los filtros siguen el formato campo=OPERADOR.VALOR:

HTTP
1	`GET /recurso/?campo=OPERADOR.VALOR`

Operadores disponibles¶

Operador	Operación	Ejemplo	Explicación
`igual`	Igualdad exacta	`?codigo=igual.0001`	Filtrando entidades con código igual a mil1
`diferente`	A diferencia de	`?deletado=diferente.true`	Filtrando entidades con atributo borrado diferente de true
`em`	En una lista de valores	`?id=em.(id1,id2,id3)`	Filtrando entidades con ids que están entre id1, id2 y id3
`maior-igual`	≥ (mayor o igual)	`?criadoEm=maior-igual.2026-01-01`	Filtrando entidades con fecha de creación mayor o igual a 01/01/2026
`menor-igual`	≤ (menor o igual)	`?criadoEm=menor-igual.2026-12-31`	Filtrando entidades con fecha de creación menor o igual a 31/01/2026

Es posible utilizar los campos criadoEm, ultimaAtualizacaoEm y deletadoEm Para realizar integraciones incrementales, por ejemplo.

Ejemplos de uso¶

Filtro sencillo por código¶

HTTP
1	`GET /jornadas/?codigo=igual.0001`

Filtro por múltiples IDs¶

HTTP
1	`GET /jornadas/?id=em.(1d3fc7947bee78a5179720a,2a4bc8058cff89b6280831b)`

Filtro por intervalo de fechas¶

HTTP
1	`GET /jornadas/?criadoEm=maior-igual.2025-01-01T00:00:00-03:00&criadoEm=menor-igual.2025-12-31T23:59:59-03:00`

Filtrar solo registros no borrados¶

HTTP
1	`GET /jornadas/?deletado=igual.false`

Combinando filtros¶

Múltiples filtros se pueden combinar en la misma requisición. Todos los filtros se aplican con lógica AND:

HTTP
1 2	`# Jornadas de trabalho ativas, criadas em 2025 GET /jornadas/?ehJornadaDeTrabalho=igual.true&deletado=igual.false&criadoEm=maior-igual.2025-01-01T00:00:00-03:00`

Filtros por entidad¶

Jornadas¶

Parámetro	Operadores	Descripción
`id`	`igual`, `em`	Filtrar por identificador
`codigo`	`igual`, `em`	Filtrar por código
`nome`	`igual`	Filtrar por nombre exacto
`ehJornadaDeTrabalho`	`igual`	Solo jornadas de trabajo (`true`/`false`)
`deletado`	`igual`	Incluir o excluir deletados (`true`/`false`)
`criadoEm`	`maior-igual`, `menor-igual`	Filtrar por fecha de creación
`ultimaModificacaoEm`	`maior-igual`, `menor-igual`	Filtrar por fecha de modificación

Empleados¶

Parámetro	Operadores	Descripción
`id`	`igual`, `em`	Filtrar por identificador
`cpf`	`igual`	Buscar por CPF
`rg`	`igual`	Buscar RG
`codigo_funcionario`	`igual`	Buscar código interno
`email`	`igual`	Buscar por correo
`empregador_id`	`igual`, `em`	Filtrar por empresa

Empleadores¶

Parámetro	Operadores	Descripción
`id`	`igual`, `em`	Filtrar por identificador
`cnpj`	`igual`	Buscar por CNPJ
`cpf`	`igual`	Buscar por CPF (persona física)
`codigo`	`igual`	Buscar código

Ejemplos en código¶

PythonJavaScriptcURL

Python
import requests

headers = {"Authorization": f"Bearer {access_token}"}

# Jornadas de trabalho ativas
response = requests.get(
    "https://apis.pontotel.com.br/pontotel/api/v4/jornadas/",
    headers=headers,
    params={
        "ehJornadaDeTrabalho": "igual.true",
        "deletado": "igual.false"
    }
)

data = response.json()
print(f"Jornadas encontradas: {data['total']}")

JavaScript
const params = new URLSearchParams({
  ehJornadaDeTrabalho: 'igual.true',
  deletado: 'igual.false'
});

const response = await fetch(
  `https://apis.pontotel.com.br/pontotel/api/v4/jornadas/?${params}`,
  { headers: { Authorization: `Bearer ${accessToken}` } }
);

const data = await response.json();
console.log('Jornadas encontradas:', data.total);

Bash
curl -G "https://apis.pontotel.com.br/pontotel/api/v4/jornadas/" \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode "ehJornadaDeTrabalho=igual.true" \
  --data-urlencode "deletado=igual.false"

Siguientes pasos¶

Identificadores en referencias →