> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salvy.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Detalhar colaborador

> Busca um colaborador da empresa pelo ID.



## OpenAPI

````yaml api-reference/v3/openapi.json GET /api/v3/employees/{id}
openapi: 3.1.0
info:
  version: v3
  title: Salvy API
  x-logo:
    url: web/logo.png
servers:
  - url: https://api.salvy.com.br
    description: Salvy API URL
security:
  - bearerAuth: []
tags:
  - name: Public API
  - name: Outgoing Webhooks
paths:
  /api/v3/employees/{id}:
    get:
      tags:
        - Public API
      description: Busca um colaborador da empresa pelo ID.
      operationId: publicGetEmployeeV3
      parameters:
        - name: id
          in: path
          required: true
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  id:
                    description: Identificador do colaborador na plataforma Salvy (UUID)
                    example: 123e4567-e89b-12d3-a456-426614174000
                    title: UUID
                    type: string
                    examples:
                      - 123e4567-e89b-12d3-a456-426614174000
                      - 123e4567-e89b-12d3-a456-426614174001
                  companyId:
                    description: ID da empresa dona do colaborador.
                    example: 123e4567-e89b-12d3-a456-426614174000
                    title: UUID
                    type: string
                    examples:
                      - 123e4567-e89b-12d3-a456-426614174000
                      - 123e4567-e89b-12d3-a456-426614174001
                  fullName:
                    type: string
                    description: Nome completo
                    example: João da Silva
                  socialName:
                    description: Nome social
                    example: João
                    type:
                      - string
                      - 'null'
                  status:
                    type: string
                    enum:
                      - active
                      - terminated
                      - on-hold
                    description: Situação do colaborador
                    example: active
                  workEmail:
                    anyOf:
                      - title: Email
                        type: string
                        description: A valid email address.
                        examples:
                          - user@example.com
                          - admin@domain.org
                          - info@company.net
                      - type: 'null'
                    description: E-mail profissional
                    example: joaosilva@empresa.com.br
                  personalEmail:
                    anyOf:
                      - title: Email
                        type: string
                        description: A valid email address.
                        examples:
                          - user@example.com
                          - admin@domain.org
                          - info@company.net
                      - type: 'null'
                    description: E-mail pessoal
                    example: joaos04@gmail.com
                  workPhoneNumber:
                    anyOf:
                      - title: PhoneNumberE164
                        type: string
                        description: >-
                          Phone number in E.164 format. Supports Brazilian
                          numbers (+55).
                        examples:
                          - '+5511999999999'
                          - '+551139999999'
                      - type: 'null'
                    description: Telefone profissional
                    example: '+5541923456789'
                  personalPhoneNumber:
                    anyOf:
                      - title: PhoneNumberE164
                        type: string
                        description: >-
                          Phone number in E.164 format. Supports Brazilian
                          numbers (+55).
                        examples:
                          - '+5511999999999'
                          - '+551139999999'
                      - type: 'null'
                    description: Telefone pessoal
                    example: '+5541987654321'
                  cpf:
                    anyOf:
                      - title: CPF
                        type: string
                        description: A valid CPF number.
                        examples:
                          - 123.456.789-09
                          - '12345678909'
                      - type: 'null'
                    description: Número do CPF
                    example: 198.099.750-07
                  cnpj:
                    anyOf:
                      - title: CNPJ
                        type: string
                        description: A valid CNPJ number (numeric or alphanumeric).
                        examples:
                          - 12.345.678/0001-95
                          - '12345678000195'
                          - 12.ABC.345/01DE-35
                      - type: 'null'
                    description: CNPJ do colaborador
                    example: 82.530.339/0001-64
                  rg:
                    description: RG do colaborador
                    example: 12.345.678-9
                    type:
                      - string
                      - 'null'
                  position:
                    description: Cargo do colaborador
                    example: Desenvolvedor
                    type:
                      - string
                      - 'null'
                  area:
                    description: Área do colaborador
                    example: Engenharia
                    type:
                      - string
                      - 'null'
                  managerFullName:
                    description: Nome do gestor
                    example: Maria dos Santos
                    type:
                      - string
                      - 'null'
                  birthDate:
                    anyOf:
                      - title: PlainDate
                        type: string
                        description: A date in ISO 8601 format.
                        examples:
                          - '2023-10-05'
                      - type: 'null'
                    description: Data de nascimento
                    example: '1990-04-15'
                  contractType:
                    anyOf:
                      - type: string
                        enum:
                          - pj
                          - clt
                          - intern
                          - apprentice
                          - temporary
                          - third-party
                      - type: 'null'
                    description: Tipo de contrato
                    example: clt
                  contractEndDate:
                    anyOf:
                      - title: PlainDate
                        type: string
                        description: A date in ISO 8601 format.
                        examples:
                          - '2023-10-05'
                      - type: 'null'
                    description: Data de término do contrato
                    example: '2023-12-31'
                  admittedAt:
                    anyOf:
                      - title: PlainDate
                        type: string
                        description: A date in ISO 8601 format.
                        examples:
                          - '2023-10-05'
                      - type: 'null'
                    description: Data de admissão
                    example: '2020-05-27'
                  terminatedAt:
                    anyOf:
                      - title: PlainDate
                        type: string
                        description: A date in ISO 8601 format.
                        examples:
                          - '2023-10-05'
                      - type: 'null'
                    description: Data de desligamento
                    example: '2021-01-30'
                  address:
                    anyOf:
                      - type: object
                        properties:
                          zipCode:
                            description: CEP
                            example: 12345-678
                            type:
                              - string
                              - 'null'
                          streetName:
                            description: Nome da rua
                            example: Rua das Flores
                            type:
                              - string
                              - 'null'
                          streetNumber:
                            description: Número da casa
                            example: '123'
                            type:
                              - string
                              - 'null'
                          complement:
                            description: Complemento do endereço
                            example: Apto 101
                            type:
                              - string
                              - 'null'
                          neighborhood:
                            description: Bairro
                            example: Jardim das Flores
                            type:
                              - string
                              - 'null'
                          city:
                            description: Cidade
                            example: São Paulo
                            type:
                              - string
                              - 'null'
                          state:
                            description: Estado
                            example: SP
                            type:
                              - string
                              - 'null'
                          country:
                            description: País
                            example: Brasil
                            type:
                              - string
                              - 'null'
                        required:
                          - zipCode
                          - streetName
                          - streetNumber
                          - complement
                          - neighborhood
                          - city
                          - state
                          - country
                        additionalProperties: false
                      - type: 'null'
                    description: Endereço do colaborador
                  bankAccount:
                    anyOf:
                      - type: object
                        properties:
                          bank:
                            description: Banco
                            example: Banco do Brasil
                            type:
                              - string
                              - 'null'
                          branch:
                            description: Agência
                            example: '1234'
                            type:
                              - string
                              - 'null'
                          accountNumber:
                            description: Número da conta
                            example: '123456'
                            type:
                              - string
                              - 'null'
                          accountType:
                            anyOf:
                              - type: string
                                enum:
                                  - checking
                                  - savings
                                  - salary
                                  - payment
                              - type: 'null'
                            description: Tipo de conta
                            example: checking
                          pixKey:
                            description: Chave PIX
                            example: joao04@gmail.com
                            type:
                              - string
                              - 'null'
                        required:
                          - bank
                          - branch
                          - accountNumber
                          - accountType
                          - pixKey
                        additionalProperties: false
                      - type: 'null'
                    description: Dados bancários do colaborador
                  salaryCents:
                    description: Salário em centavos
                    example: 500000
                    type:
                      - number
                      - 'null'
                  customFields:
                    type: array
                    items:
                      type: object
                      properties:
                        label:
                          type: string
                        type:
                          type: string
                          enum:
                            - text
                            - select
                        value:
                          type: string
                      required:
                        - label
                        - type
                        - value
                      additionalProperties: false
                    description: Campos personalizados do colaborador
                    example:
                      - label: teste
                        type: text
                        value: teste
                  sources:
                    readOnly: true
                    description: Fontes de integração do colaborador
                    example:
                      - id: '123'
                        platform: api
                    type: array
                    items:
                      anyOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              const: manual
                            platform:
                              type: string
                              const: manual
                          required:
                            - id
                            - platform
                          additionalProperties: false
                        - type: object
                          properties:
                            id:
                              type: string
                            platform:
                              type: string
                              const: sheets
                          required:
                            - id
                            - platform
                          additionalProperties: false
                        - type: object
                          properties:
                            id:
                              type: string
                            platform:
                              type: string
                          required:
                            - id
                            - platform
                          additionalProperties: false
                  createdAt:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                    description: Data de criação do colaborador
                    example: '2025-01-01T00:00:00.000Z'
                required:
                  - id
                  - companyId
                  - fullName
                  - socialName
                  - status
                  - workEmail
                  - personalEmail
                  - workPhoneNumber
                  - personalPhoneNumber
                  - cpf
                  - cnpj
                  - rg
                  - position
                  - area
                  - managerFullName
                  - birthDate
                  - contractType
                  - contractEndDate
                  - admittedAt
                  - terminatedAt
                  - address
                  - bankAccount
                  - salaryCents
                  - customFields
                  - sources
                  - createdAt
                additionalProperties: false
        '401':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unauthorized
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '403':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - forbidden
                      - insufficient-scope
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - resource-not-found
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '413':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - payload-too-large
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '422':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - input-validation-error
                      - unprocessable-entity
                      - company-not-active
                  message:
                    type: string
                  details:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        message:
                          type: string
                      required:
                        - key
                        - message
                      additionalProperties: false
                required:
                  - code
                  - message
                additionalProperties: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unknown
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
      deprecated: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: key

````