Filters and Query Parameters¶

Overview¶

API listing endpoints Pontotel support filters via Query parameters to refine and seek specific data.

Filter Syntax¶

Filters follow format campo=OPERADOR.VALOR:

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

Available operators¶

Operator	Operation	Example	Explanation
`igual`	Exact equality	`?codigo=igual.0001`	Filtering entities with code equal to 0001
`diferente`	Unlike	`?deletado=diferente.true`	Filtering entities with different deleted attribute from true
`em`	In a list of values	`?id=em.(id1,id2,id3)`	Filtering entities with ids that are between id1, id2 and id3
`maior-igual`	≥ (larger or equal)	`?criadoEm=maior-igual.2026-01-01`	Filtering entities with creation date greater than or equal to 01/01/2026
`menor-igual`	≤ (minor or equal)	`?criadoEm=menor-igual.2026-12-31`	Filtering entities with creation date less than or equal to 31/01/2026

Can use fields criadoEm, ultimaAtualizacaoEm and deletadoEm to perform incremental integrations, for example.

Examples of use¶

Code simple filter¶

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

Multiple ID Filter¶

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

Date range filter¶

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

Filter only undelete records¶

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

Combining filters¶

Multiple filters can be combined in the same request. All filters are applied with logic 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`

Entity Filters¶

Days¶

Parameter	Operators	Description
`id`	`igual`, `em`	Filter by identifier
`codigo`	`igual`, `em`	Filter by code
`nome`	`igual`	Filter by exact name
`ehJornadaDeTrabalho`	`igual`	Only working days (`true`/`false`)
`deletado`	`igual`	Include or delete deleted (`true`/`false`)
`criadoEm`	`maior-igual`, `menor-igual`	Filter by creation date
`ultimaModificacaoEm`	`maior-igual`, `menor-igual`	Filter by modification date

Employees¶

Parameter	Operators	Description
`id`	`igual`, `em`	Filter by identifier
`cpf`	`igual`	Search by CPF
`rg`	`igual`	Search for ID
`codigo_funcionario`	`igual`	Search by internal code
`email`	`igual`	Search by email
`empregador_id`	`igual`, `em`	Filter by company

Employers¶

Parameter	Operators	Description
`id`	`igual`, `em`	Filter by identifier
`cnpj`	`igual`	Search for CNPJ
`cpf`	`igual`	Search by number (physical person)
`codigo`	`igual`	Search by code

Code Examples¶

Python

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"

Text Only
```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);
```

curl

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"

Next Steps¶

Identifiers in references →