Sign in

v1

latestOpenAPI 3.1.02026-07-26160119.8 KB
Public API

Cria ou atualiza um colaborador.

post/api/v1/employees/sync

Request body

integrationIdstring required

Identificador único de sua escolha para esse colaborador

forceCreateboolean

Quando true, ignora a busca por colaboradores existentes (por integrationId, cpf, workEmail e fullName) e cria um novo colaborador. Útil para cadastrar intencionalmente um colaborador duplicado.

fullNamestring required

Nome completo

socialNamestring

Nome social

status'active' | 'terminated' | 'on-hold' required

Situação do colaborador

workEmailstring

E-mail profissional

personalEmailstring

E-mail pessoal

workPhoneNumberstring

Telefone profissional

personalPhoneNumberstring

Telefone pessoal

cpfstring

Número do CPF

positionstring

Cargo do colaborador

areastring

Área do colaborador

managerFullNamestring

Nome do gestor

birthDatestring

Data de nascimento

admittedAtstring

Data de admissão

terminatedAtstring

Data de desligamento

Example request

{
  "integrationId": "123",
  "fullName": "João da Silva",
  "socialName": "João",
  "status": "active",
  "workEmail": "joaosilva@empresa.com.br",
  "personalEmail": "joaos04@gmail.com",
  "workPhoneNumber": "+5541923456789",
  "personalPhoneNumber": "+5541987654321",
  "cpf": "198.099.750-07",
  "position": "Desenvolvedor",
  "area": "Engenharia",
  "managerFullName": "Maria dos Santos",
  "birthDate": "1990-04-15",
  "admittedAt": "2020-05-27",
  "terminatedAt": "2021-01-20",
  "address": {
    "zipCode": "12345-678",
    "streetName": "Rua das Flores",
    "streetNumber": "123",
    "complement": "Apto 101",
    "neighborhood": "Jardim das Flores",
    "city": "São Paulo",
    "state": "SP",
    "country": "Brasil"
  }
}

Response

idstring required

Identificador do colaborador na plataforma Salvy (UUID)

fullNamestring required

Nome completo

socialNamestring nullable required

Nome social

status'active' | 'terminated' | 'on-hold' required

Situação do colaborador

workEmailstring nullable required

A valid email address.

personalEmailstring nullable required

A valid email address.

workPhoneNumberstring nullable required

Phone number in E.164 format. Supports Brazilian numbers (+55).

personalPhoneNumberstring nullable required

Phone number in E.164 format. Supports Brazilian numbers (+55).

cpfstring nullable required

A valid CPF number.

cnpjstring nullable required

A valid CNPJ number (numeric or alphanumeric).

rgstring nullable required

RG do colaborador

positionstring nullable required

Cargo do colaborador

areastring nullable required

Área do colaborador

managerFullNamestring nullable required

Nome do gestor

birthDatestring nullable required

A date in ISO 8601 format.

contractType'pj' | 'clt' | 'intern' | 'apprentice' | 'temporary' | 'third-party' nullable required

Tipo de contrato

contractEndDatestring nullable required

A date in ISO 8601 format.

admittedAtstring nullable required

A date in ISO 8601 format.

terminatedAtstring nullable required

A date in ISO 8601 format.

salaryCentsnumber nullable required

Salário em centavos

createdAtstring date-time required

Data de criação do colaborador

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "fullName": "João da Silva",
  "socialName": "João",
  "status": "active",
  "workEmail": "joaosilva@empresa.com.br",
  "personalEmail": "joaos04@gmail.com",
  "workPhoneNumber": "+5541923456789",
  "personalPhoneNumber": "+5541987654321",
  "cpf": "198.099.750-07",
  "cnpj": "82.530.339/0001-64",
  "rg": "12.345.678-9",
  "position": "Desenvolvedor",
  "area": "Engenharia",
  "managerFullName": "Maria dos Santos",
  "birthDate": "1990-04-15",
  "contractType": "clt",
  "contractEndDate": "2023-12-31",
  "admittedAt": "2020-05-27",
  "terminatedAt": "2021-01-30",
  "address": {
    "zipCode": "12345-678",
    "streetName": "Rua das Flores",
    "streetNumber": "123",
    "complement": "Apto 101",
    "neighborhood": "Jardim das Flores",
    "city": "São Paulo",
    "state": "SP",
    "country": "Brasil"
  },
  "customFields": [
    {
      "label": "teste",
      "type": "text",
      "value": "teste"
    }
  ],
  "bankAccount": {
    "bank": "Banco do Brasil",
    "branch": "1234",
    "accountNumber": "123456",
    "accountType": "checking",
    "pixKey": "joao04@gmail.com"
  },
  "salaryCents": 500000,
  "sources": [
    {
      "id": "123",
      "platform": "api"
    }
  ],
  "createdAt": "2025-01-01T00:00:00.000Z"
}