Listar vínculos empregatícios
Retorna todos os vínculos empregatícios, ordenados por data de criação, com os mais recentes primeiro.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Filtro no campo customer.externalId
do vínculo empregatício, aceitando string ou lista separada por vírgula.
Filtro no campo status
do vínculo empregatício, aceitando um status válido ou lista separada por vírgula.
working
, vacation
, terminated
, deceased
, away
, transferred
Retorna apenas o último status de cada funcionário
Um filtro com base no campo company
. O valor deve ser uma string ou uma lista separada por vírgula.
Um filtro com base no campo document
. O valor deve ser uma string ou uma lista separada por vírgula
Expande as referências.
Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.
Um cursor para uso na paginação. starting_after
é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo
, sua chamada subsequente poderá incluir starting_after=obj_foo
para buscar a próxima página da lista.
Um cursor para uso na paginação. starting_after
é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo
, sua chamada subsequente poderá incluir starting_after=obj_foo
para buscar a próxima página da lista.
Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.
Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.
Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.
Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.
Um filtro com base no campo deleted
. O valor deve ser um booleano.
Response
Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter
.
Uma lista de vínculos empregatícios