Listando pessoas colaboradoras

Sobre este guia

Através deste guia, demonstraremos como listar pessoas colaboradoras.

Passo a passo

Ambientes

• Ambiente de homologação: https://uat-collaborators-api.acessorh.com.br;
• Ambiente de produção: https://collaborators-api.acessorh.com.br.

1. Obtenha um token OAuth válido

   Caso tenha dúvidas de como obter um token visite a seção sobre autenticação.

2. Listando pessoas colaboradoras

   Após gerar um token de acesso válido, faça uma requisição para o endpoint de listagem de pessoas colaboradoras na nossa API REST (GET/api/v1/employees/).

   Abaixo um exemplo da requisição:

   curl --location 'https://collaborators-api.acessorh.com.br/api/v1/employees?page=1&pageSize=10&sortOrder=asc' \
   --header 'accountid: {ACCOUNT}' \
   --header 'authorization: Bearer {ACCESS_TOKEN}'

   Você receberá o retorno no formato seguinte:

   {
       "data": [
           {
               "id": "6b430032-3966-46e3-8492-49494fd29a09",
               "name": "Test Test",
               "role": "00000000-0000-0000-0000-000000000000",
               "department": "00000000-0000-0000-0000-000000000000",
               "unit": "00000000-0000-0000-0000-000000000000",
               "admission": {
                   "id": "00000000-0000-0000-0000-000000000000",
                   "organizationID": "00000000-0000-0000-0000-000000000000"
               },
               "active": true,
               "identificator": "123456789",
               "identificatorType": "cpf",
               "organizationID": "541c9413-2979-419e-b3bc-b13dc189ad60",
               "positionID": "00000000-0000-0000-0000-000000000000",
               "employeeCode": "999999"
           },
           {
               "id": "e0bb12f5-1a55-4cb0-b241-984debbfd989",
               "name": "Test Test",
               "role": "00000000-0000-0000-0000-000000000000",
               "department": "00000000-0000-0000-0000-000000000000",
               "unit": "00000000-0000-0000-0000-000000000000",
               "admission": {
                   "id": "00000000-0000-0000-0000-000000000000",
                   "organizationID": "00000000-0000-0000-0000-000000000000"
               },
               "active": true,
               "identificator": "123455789",
               "identificatorType": "cpf",
               "organizationID": "541c9413-2979-419e-b3bc-b13dc189ad60",
               "positionID": "00000000-0000-0000-0000-000000000000",
               "employeeCode": "22342"
           },
           {
               "id": "19fda50b-87a6-4c19-8a75-b89e6fbd5c42",
               "name": "New new Test",
               "role": "00000000-0000-0000-0000-000000000000",
               "department": "00000000-0000-0000-0000-000000000000",
               "unit": "00000000-0000-0000-0000-000000000000",
               "admission": {
                   "id": "00000000-0000-0000-0000-000000000000",
                   "organizationID": "00000000-0000-0000-0000-000000000000"
               },
               "active": true,
               "identificator": "123455780",
               "identificatorType": "cpf",
               "organizationID": "541c9413-2979-419e-b3bc-b13dc189ad60",
               "positionID": "00000000-0000-0000-0000-000000000000",
               "employeeCode": "1234623424"
           }
       ],
       "total": 3,
       "paginator": {
           "page": 1,
           "pageSize": 10,
           "totalRows": 3,
           "totalPages": 1
       },
       "requestId": "3a98a2a4-d5f8-44b5-b839-c2c8ebe11ad6"
   }