Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
required

Número da página, iniciando em 1.

Required range: 1 <= x <= 9007199254740991
Example:

1

pageSize
integer
default:50
required

Tamanho da página. Máximo de 200.

Required range: 1 <= x <= 200
Example:

50

status
enum<string>[]

Filtra pela situação do colaborador. Repita o parâmetro para incluir múltiplos valores (?status=active&status=on-hold).

Available options:
active,
terminated,
on-hold
Example:

"active"

contractType
(enum<string> | string)[]

Filtra pelo tipo de contrato do colaborador. Repita o parâmetro para incluir múltiplos valores. Use __null__ para filtrar colaboradores sem tipo de contrato definido.

Available options:
pj,
clt,
intern,
apprentice,
temporary,
third-party
Example:

"clt"

cpf
string

Filtra pelo CPF exato do colaborador. Aceita o valor formatado (com pontuação) ou apenas os dígitos.

Example:

"198.099.750-07"

admittedAtFrom
string

Filtra colaboradores admitidos a partir desta data (inclusivo), em formato YYYY-MM-DD.

Example:

"2026-05-01"

admittedAtTo
string

Filtra colaboradores admitidos até esta data (exclusivo), em formato YYYY-MM-DD. Para incluir o dia inteiro, use a data seguinte (ex.: para incluir todo o dia 2026-05-31, use admittedAtTo=2026-06-01).

Example:

"2026-06-01"

terminatedAtFrom
string

Filtra colaboradores desligados a partir desta data (inclusivo), em formato YYYY-MM-DD.

Example:

"2026-05-01"

terminatedAtTo
string

Filtra colaboradores desligados até esta data (exclusivo), em formato YYYY-MM-DD. Para incluir o dia inteiro, use a data seguinte (ex.: para incluir todo o dia 2026-05-31, use terminatedAtTo=2026-06-01).

Example:

"2026-06-01"

sortBy
enum<string>

Campo usado para ordenar o resultado. Padrão: createdAt.

Available options:
createdAt,
fullName,
admittedAt
Example:

"createdAt"

sortOrder
enum<string>

Direção da ordenação. Padrão: desc.

Available options:
asc,
desc
Example:

"desc"

Response

data
object[]
required
pagination
object
required