Listar Colaboradores

get

https://client-api.vlow.com.br/v1/employee

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Endpoint responsável por coletar e exibir os colaboradores de uma determinada empresa. Responde com um array chamado employees, com cada colaborador sendo um objeto. Para casos onde não há colaboradores, será retornado um array vazio.

Query Params

limit

int32

Defaults to 10

Máximo de resultados exibidos em uma página

page

int32

Defaults to 1

Paginador para casos onde o número de resultados excede o parâmetro limit

cpf

string

CPF do colaborador

departmentId

string

ID interno do departamento a ser pesquisado

jobRoleLevelId

string

ID interno do cargo a ser pesquisado

status

string

enum

Possíveis status de colaborador a serem pesquisados

Allowed:

string

Email do colaborador a ser pesquisado

admissionDateStart

date

Data de admissão inicial dos colaboradores a serem pesquisados

admissionDateEnd

date

Data de admissão final dos colaboradores a serem pesquisados

disconnectedAtStart

date

Data de desligamento inicial dos colaboradores a serem pesquisados

disconnectedAtEnd

date

Data de desligamento final dos colaboradores a serem pesquisados

createdAtStart

date

Data de criação inicial dos colaboradores a serem pesquisados. O formato segue o seguinte padrão YYYY-MM-DDTHH:mm:ss

createdAtEnd

date

Data de criação final dos colaboradores a serem pesquisados. O formato segue o seguinte padrão YYYY-MM-DDTHH:mm:ss

updatedAtStart

date

Data de atualização inicial dos colaboradores a serem pesquisados. O formato segue o seguinte padrão YYYY-MM-DDTHH:mm:ss

updatedAtEnd

date

Data de atualização final dos colaboradores a serem pesquisados. O formato segue o seguinte padrão YYYY-MM-DDTHH:mm:ss

deletedAtStart

date

Data de remoção inicial dos colaboradores a serem pesquisados. O formato segue o seguinte padrão YYYY-MM-DDTHH:mm:ss

deletedAtEnd

date

Data de remoção final dos colaboradores a serem pesquisados. O formato segue o seguinte padrão YYYY-MM-DDTHH:mm:ss

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

401401

404404