Filtros e query parameters¶

Visão geral¶

Os endpoints de listagem da API Pontotel suportam filtros via query parameters para refinar e buscar dados específicos.

Sintaxe dos filtros¶

Os filtros seguem o formato campo=OPERADOR.VALOR:

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

Operadores disponíveis¶

Operador	Operação	Exemplo	Explicação
`igual`	Igualdade exata	`?codigo=igual.0001`	Filtrando entidades com código igual a 0001
`diferente`	Diferente de	`?deletado=diferente.true`	Filtrando entidades com atributo deletado diferente de true
`em`	Em uma lista de valores	`?id=em.(id1,id2,id3)`	Filtrando entidades com ids que estão entre id1, id2 e id3
`maior-igual`	≥ (maior ou igual)	`?criadoEm=maior-igual.2026-01-01`	Filtrando entidades com data de criação maior ou igual a 01/01/2026
`menor-igual`	≤ (menor ou igual)	`?criadoEm=menor-igual.2026-12-31`	Filtrando entidades com data de criação menor ou igual a 31/01/2026

É possível utilizar os campos criadoEm, ultimaAtualizacaoEm e deletadoEm para realizar integrações incrementais, por exemplo.

Exemplos de uso¶

Filtro simples por código¶

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

Filtro por múltiplos IDs¶

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

Filtro por intervalo de datas¶

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 apenas registros não deletados¶

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

Combinando filtros¶

Múltiplos filtros podem ser combinados na mesma requisição. Todos os filtros são aplicados com 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`

Exemplos de Filtros por entidades¶

Jornadas¶

Parâmetro	Operadores	Descrição
`id`	`igual`, `em`	Filtrar por identificador
`codigo`	`igual`, `em`	Filtrar por código
`nome`	`igual`	Filtrar por nome exato
`ehJornadaDeTrabalho`	`igual`	Somente jornadas de trabalho (`true`/`false`)
`deletado`	`igual`	Incluir ou excluir deletados (`true`/`false`)
`criadoEm`	`maior-igual`, `menor-igual`	Filtrar por data de criação
`ultimaModificacaoEm`	`maior-igual`, `menor-igual`	Filtrar por data de modificação

Empregados¶

Parâmetro	Operadores	Descrição
`id`	`igual`, `em`	Filtrar por identificador
`cpf`	`igual`	Buscar por CPF
`rg`	`igual`	Buscar por RG
`codigo_funcionario`	`igual`	Buscar por código interno
`email`	`igual`	Buscar por e-mail
`empregador_id`	`igual`, `em`	Filtrar por empresa

Empregadores¶

Parâmetro	Operadores	Descrição
`id`	`igual`, `em`	Filtrar por identificador
`cnpj`	`igual`	Buscar por CNPJ
`cpf`	`igual`	Buscar por CPF (pessoa física)
`codigo`	`igual`	Buscar por código

Exemplos em 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"

Próximos Passos¶

Identificadores em referências →