Skip to main content
GET
Retorna os dados dos colaboradores
API v1 - Este endpoint está disponível apenas na v1

Authorizations

Authorization
string
header
required

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

Path Parameters

pageNumber
integer
required

Determina o número da página a ser retornada.

pageLimit
integer
required

Limita a quantidade de registros retornados por página.

Query Parameters

createdBefore
string

A pesquisa retorna registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DD).

createdAfter
string

A pesquisa retorna registros criados a partir desta data passada no parâmetro. Formato (AAAA-MM-DD).

state
string

A pesquisa retorna registros criados com o estado do colaborador igual ao da Unidade Federativa passada no parâmetro. Formato (UF).

Response

OK

name
string
Example:

"Nome"

surname
string
Example:

"Sobrenome"

email
string
Example:

"email@email.com"

cellphone
string
Example:

"(00) 00000-0000"

role
string
Example:

"Vendedor"

address
object