​Listar Colaboradores

Este endpoint permite buscar colaboradores pertencentes ao grupo econômico de sua empresa. Pode ser utilizado para filtrar e recuperar informações sobre colaboradores de diferentes unidades ou subsidiárias de um conglomerado econômico.

URL: /employees
Método: GET
Descrição: Busca por colaboradores pertencentes ao grupo econômico. Busca com multiplos valores devem ser feitas através de valores separados por vírgula.
Ex.: /employees?documentNumbers=123,321,456

Headers:

• x-flash-auth: <chave_api>

Parâmetros de Rota:

• limit - Número de documentos de Colaborador por página
• order - Maneira a qual os documentos serão ordenados. Crescente ('asc') ou decrescente ('desc').
• page - Página da resposta
• sortBy - Campo pelo qual a lista será ordenada. Ex.: 'name'
• companyId - Filtra pelo id da empresa
• status - Filtra pelos status do colaborador. É possível fazer a pesquisa por exclusão colocando um hífen - na frente do status a ser excluído.
  Ex.: ?status=-INVITATION_SENT
• documentNumbers - Filtra pelo CPF do colaborador
• externalIds - Filtra pelo ID externo
• query - Realiza a procura nos campos nome, cpf, email ou telefone