Busca dados de RH de um usuário

curl --request GET \
  --url https://app.tarefy.com/nodeapi/v2/employee-hr-data/{userId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.tarefy.com/nodeapi/v2/employee-hr-data/{userId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.tarefy.com/nodeapi/v2/employee-hr-data/{userId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.tarefy.com/nodeapi/v2/employee-hr-data/{userId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.tarefy.com/nodeapi/v2/employee-hr-data/{userId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.tarefy.com/nodeapi/v2/employee-hr-data/{userId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "primeiro_nome": "Ana",
  "ultimo_nome": "Exemplo",
  "email": "ana@example.com",
  "empresa": "Empresa Exemplo",
  "salario": null,
  "regime_trabalho": null,
  "has_hr_data": false
}

Employee HR Data

Busca dados de RH de um usuário

Requer autenticação Bearer e pelo menos uma das permissões 18 ou 19, conforme as regras de autorização da conta. A conta é obtida da autenticação; não envie account_id.

Retorna o cadastro usado pela tela de dados pessoais do perfil. Aceita vínculo inativo para consultar ex-colaboradores. Usuário inexistente ou sem vínculo com a conta retorna HTTP 200 vazio (o serviço retorna null), e não 404.

Se o usuário pertence à conta mas não tem registro ativo de RH, retorna dados disponíveis do perfil com has_hr_data=false; campos exclusivos de RH podem estar ausentes. Com registro ativo, has_hr_data=true. empresa vem da conta autenticada. salario e regime_trabalho vêm do histórico salarial e são null sem permissão 18 ou sem valor disponível. Veja o guia de dados pessoais.

GET

employee-hr-data

{userId}

Busca dados de RH de um usuário

curl --request GET \
  --url https://app.tarefy.com/nodeapi/v2/employee-hr-data/{userId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.tarefy.com/nodeapi/v2/employee-hr-data/{userId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.tarefy.com/nodeapi/v2/employee-hr-data/{userId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.tarefy.com/nodeapi/v2/employee-hr-data/{userId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.tarefy.com/nodeapi/v2/employee-hr-data/{userId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.tarefy.com/nodeapi/v2/employee-hr-data/{userId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "primeiro_nome": "Ana",
  "ultimo_nome": "Exemplo",
  "email": "ana@example.com",
  "empresa": "Empresa Exemplo",
  "salario": null,
  "regime_trabalho": null,
  "has_hr_data": false
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId

integer

required

ID do usuário

Response

object | null

Perfil consolidado, ou corpo vazio quando o usuário não existe ou não pertence à conta.

Objeto consolidado. Campos podem estar ausentes ou nulos quando não houver dados de RH.

primeiro_nome

string | null

Primeiro nome do colaborador.

ultimo_nome

string | null

Sobrenome(s) do colaborador.

nome_registro

string | null

Nome de registro/documentos.

string | null

Telefone internacional com código do país, preferencialmente E.164, como +5511999999999. Máscaras são removidas e o número é validado.

string | null

Email de acesso. É normalizado para minúsculas e não pode estar vazio nem pertencer a outro usuário.

cargo

string | null

Nome exato de um cargo já cadastrado na conta. Nome inexistente ou string vazia remove a associação; não cria um cargo.

string | null

Endereço do perfil no LinkedIn.

endereco_completo

string | null

Logradouro/endereço completo.

cidade

string | null

Cidade.

estado

string | null

UF; convertida para maiúsculas e limitada a 2 caracteres.

cep

string | null

CEP como texto. Máscaras são removidas e apenas os primeiros 8 dígitos são mantidos.

data_nascimento

string<date> | null

Data de nascimento. Envie YYYY-MM-DD (por exemplo, 2026-09-17).

nome_pais

string | null

Nome do pai. O nome histórico do campo é nome_pais.

nome_mae

string | null

Nome da mãe.

email_pessoal

string | null

Email pessoal, separado do email de acesso.

titulo

string | null

Número do título de eleitor.

escolaridade

string | null

Escolaridade, como Superior completo.

estado_civil

string | null

Estado civil.

departamento

string | null

Departamento, em texto livre.

empresa

string | null

Nome da conta autenticada.

salario

string | null

Último salário, como string, ou null sem permissão 18/valor disponível.

cpf

string | null

CPF como texto; máscaras são removidas.

string | null

RG como texto; pontos, traços e espaços são removidos e letras são convertidas para maiúsculas.

rg_orgao_emissor

string | null

Órgão emissor do RG.

rg_data_emissao

string<date-time> | null

Data de emissão do RG. Envie YYYY-MM-DD (por exemplo, 2026-09-17).

ctps

string | null

Número da carteira de trabalho; máscaras são removidas.

ctps_serie

string | null

Série da carteira de trabalho; máscaras são removidas.

pis

string | null

Número do PIS; máscaras são removidas.

cnh

string | null

Número da CNH.

cnh_categoria

string | null

Categoria da CNH; limitada a 10 caracteres.

cnh_validade

string<date-time> | null

Data de validade da CNH. Envie YYYY-MM-DD (por exemplo, 2026-09-17).

banco

string | null

Banco no registro de RH. Não sincroniza automaticamente o cadastro separado de dados bancários.

agencia

string | null

Agência bancária como texto, preservando zeros iniciais.

conta

string | null

Conta bancária como texto.

conta_tipo

string | null

Tipo de conta, em texto livre; limitado a 20 caracteres.

pix

string | null

Chave Pix do registro de RH.

bairro

string | null

Bairro.

numero

string | null

Número do endereço como texto; limitado a 20 caracteres.

complemento

string | null

Complemento do endereço.

contato_emergencia_nome

string | null

Nome do contato de emergência.

contato_emergencia_telefone

string | null

Telefone do contato de emergência.

contato_emergencia_parentesco

string | null

Parentesco do contato; limitado a 50 caracteres.

data_admissao

string<date> | null

Data de admissão no cadastro de RH; tem prioridade sobre a data legada na consulta. Envie YYYY-MM-DD (por exemplo, 2026-09-17).

data_demissao

string<date-time> | null

Data de desligamento. Informar a data não desativa o usuário. Envie YYYY-MM-DD (por exemplo, 2026-09-17).

tipo_contrato

string | null

Tipo de contrato em texto livre.

carga_horaria_semanal

integer | null

Carga horária semanal em horas inteiras.

regime_trabalho

string | null

Tipo de contrato do histórico salarial, ou null sem permissão 18/valor disponível.

data_validade_contrato

string<date> | null

Data de validade do contrato. Envie YYYY-MM-DD (por exemplo, 2026-09-17).

previsao_formatura

string<date> | null

Data prevista de formatura. Envie YYYY-MM-DD (por exemplo, 2026-09-17).

nome_faculdade

string | null

Nome da instituição de ensino.

curso

string | null

Nome do curso.

cnpj

string | null

CNPJ da pessoa jurídica contratada.

Razão social da pessoa jurídica contratada.

vale_transporte

boolean | null

Recebe vale-transporte.

vale_alimentacao

boolean | null

Recebe vale-alimentação.

vale_refeicao

boolean | null

Recebe vale-refeição.

plano_saude

boolean | null

Possui plano de saúde.

plano_odontologico

boolean | null

Possui plano odontológico.

auxilio_creche

boolean | null

Recebe auxílio-creche.

outros_beneficios

string | null

Descrição de outros benefícios.

numero_dependentes

integer | null

Quantidade de dependentes, como inteiro.

dependentes_info

object | null

Objeto JSON com informações de dependentes. Não enviar um array na raiz.

documentos_anexos

object | null

Objeto JSON com metadados de documentos. Este campo não recebe arquivos binários.

observacoes

string | null

Observações gerais em texto.

observacoes_confidenciais

string | null

Observações confidenciais do cadastro de RH.

integer

Identificador do registro, usuário ou conta, conforme o campo. Presente quando há registro de RH.

user_id

integer

Identificador do registro, usuário ou conta, conforme o campo. Presente quando há registro de RH.

account_id

integer

Identificador do registro, usuário ou conta, conforme o campo. Presente quando há registro de RH.

has_hr_data

boolean

Existe registro ativo de RH para este usuário nesta conta.

ativo

boolean

tempo_empresa_dias

integer | null

Dias desde a admissão; pode ser null.

proximo_aniversario

string | null

Próximo aniversário calculado pelo serviço.

created_at

string<date-time> | null

updated_at

string<date-time> | null

🚀 Get Started

👥 Workspace

✅ Tasks & Projects

🤝 Clients (CRM)

👤 People, Performance & Culture

⏰ Time

📋 Recruitment

⚙️ Operations

💰 Finance

Busca dados de RH de um usuário

Authorizations

Path Parameters

Response