Skip to main content

Obtendo dados de uma pessoa colaboradora

Sobre este guia​

Através deste guia, demonstraremos como obter dados de uma pessoa colaboradora.

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. Consultando o status da importação​

    Após gerar um token de acesso válido, faça uma requisição para o endpoint de consulta de importação na nossa API REST (GET/api/v1/employees/{EMPLOYEE_ID}), enviando o employeeId e account.

    Parâmetro account

    Este parâmetro deve conter o UUID de qual account dentro da sua organization você deseja efetuar essa operação.

    Exemplo de formato de um UUID: 00000000-0000-0000-0000-000000000000

    Parâmetro employeeId

    Este parâmetro deve conter o UUID da pessoa colaboradora que você deseja obter os dados.

    Exemplo de formato de um UUID: 00000000-0000-0000-0000-000000000000

    Abaixo um exemplo da requisição:

    curl --location 'https://collaborators-api.acessorh.com.br/api/v1/employees/{EMPLOYEE_ID}' \
    --header 'accountid: {ACCOUNT}' \
    --header 'authorization: Bearer {ACCESS_TOKEN}'

    Você receberá o retorno no formato seguinte:

    {
        "data": {
            "id": "e0bb12f5-1a55-4cb0-b241-984debbfd989",
            "name": "Teste teste",
            "email": "teste.teste@unico.io",
            "phone": "21123456789",
            "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": "88294217077",
            "identificatorType": "cpf",
            "organizationID": "541c9413-2979-419e-b3bc-b13dc189ad60",
            "positionID": "00000000-0000-0000-0000-000000000000",
            "employeeCode": "22342"
        },
        "total": 1
    }