Listar Status das Etapas do Onboarding

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Endpoint responsável por listar, com paginação, o andamento do onboarding (admissão) dos colaboradores da empresa no Vlow: o status de cada etapa por colaborador.
Retorna uma lista data com o id, o nome, o CPF, o responsável, o status geral do onboarding e as etapas de cada colaborador, além do objeto pagination.

A lista traz só o status de cada etapa, no formato { "status", "isCustomField" }, igual ao do endpoint "Status das Etapas do Onboarding". Para ver subetapas e documentos de um colaborador, use os endpoints por colaborador.

Filtros (query):

  • status: situação do colaborador. Padrão ADMISSION (em admissão). Aceita ACTIVE, ADMISSION, DISCONNECTING, DISCONNECTED, AWAY, TRANSFERRED e CANCELED.
  • onboardingStatus: status geral do onboarding (ex.: IN_PROGRESS, IN_REVIEW, REANALYSIS).
  • updatedFrom / updatedTo: traz o colaborador cujo cadastro ou status de alguma etapa mudou no intervalo (ISO 8601, inclusivo; sem fuso, é lido no horário de Brasília).
  • page (padrão 1) e limit (padrão 50, máximo 100). Valores inválidos retornam 400.

Sincronização incremental: a paginação é por posição. Se colaboradores mudarem durante a leitura das páginas, um item pode aparecer repetido ou ser pulado. Para acompanhar só o que mudou, guarde o horário em que a leitura começou, use-o como updatedFrom na próxima vez e desconsidere ids repetidos.

Status possíveis das etapas: PENDING, APPROVED, DISAPPROVED, INCOMPLETE e REANALYSIS. isCustomField é true nas etapas personalizadas da sua empresa no Vlow. responsible é o usuário do Vlow que cadastrou o colaborador, ou null.

Só são retornados colaboradores da empresa da credencial.

Query Params
int32
Defaults to 1

Página

int32
Defaults to 50

Itens por página (máximo 100)

string
Defaults to ADMISSION

Situação do colaborador

string

Status geral do onboarding

string

Início do intervalo de atualização (ISO 8601)

string

Fim do intervalo de atualização (ISO 8601)

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json