Public API

GET /api/v1/employees

Lista todos os colaboradores da empresa

Request

Response

Example response

{
  "employees": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fullName": "João da Silva",
      "socialName": "João",
      "status": "active",
      "workEmail": "user@example.com",
      "personalEmail": "user@example.com",
      "workPhoneNumber": "+5511999999999",
      "personalPhoneNumber": "+5511999999999",
      "cpf": "123.456.789-09",
      "cnpj": "12.345.678/0001-95",
      "rg": "12.345.678-9",
      "position": "Desenvolvedor",
      "area": "Engenharia",
      "managerFullName": "Maria dos Santos",
      "birthDate": "2023-10-05",
      "contractType": "clt",
      "contractEndDate": "2023-10-05",
      "admittedAt": "2023-10-05",
      "terminatedAt": "2023-10-05",
      "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",
      "assetCount": 10,
      "phoneAccountCount": 3,
      "externalPhoneAccountCount": 5
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.