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

# Busca colaboradores vinculados a um parâmetro de folha de pagamento



## OpenAPI

````yaml https://api.pre.pontua.tech/api/public/doc-json get /payment-sheet/parameter/{paymentSheetParameterId}/collaborators
openapi: 3.0.0
info:
  title: Pontua Public API
  description: >-
    API oficial da Pontua para integrações de clientes externos. Autentique com
    o token gerado no dashboard em **Configurações → API**. Envie o token no
    header `Authorization: Bearer <SEU_TOKEN>`.
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /payment-sheet/parameter/{paymentSheetParameterId}/collaborators:
    get:
      tags:
        - Payment Sheet
      summary: Busca colaboradores vinculados a um parâmetro de folha de pagamento
      operationId: PaymentSheetParameterController_getCollaborators
      parameters:
        - name: paymentSheetParameterId
          required: true
          in: path
          description: ID do parâmetro de folha de pagamento
          schema:
            type: string
        - name: searchText
          description: Texto pesquisado para filtrar consulta
          required: false
          in: query
          schema:
            type: string
        - name: pagina
          description: Página que deseja retornar os resultados
          required: false
          in: query
          schema:
            example: 0
            type: number
        - name: limite
          description: Quantidade de itens que retorna na consulta. Min 1 - Max 100
          required: false
          in: query
          schema:
            example: 100
            type: number
        - description: Tipo de vínculo do colaborador
          required: false
          name: collaboratorType
          in: query
          schema:
            default: CLT
            enum:
              - CLT
              - PRESTADOR_SERVICO
            type: string
      responses:
        '200':
          description: Colaboradores vinculados ao parâmetro de folha de pagamento
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSheetParameterCollaboratorsDto'
        default:
          description: "\n\t\t\t400 - Bad Request: A solicitação não está no formato correto.\n\t\t\t401 - Unauthorized: A solicitação não foi autorizada. Verifique se o token de acesso é válido.\n\t\t\t403 - Forbidden: Acesso proibido! Requer um nível de permissão mais elevado.\n\t\t\t404 - Not Found: O recurso solicitado não foi encontrado.\n\t\t\t500 - Internal Server Error: Erro de execução no servidor!\n\t\t\t"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      deprecated: false
      security:
        - bearer: []
components:
  schemas:
    PaymentSheetParameterCollaboratorsDto:
      type: object
      properties:
        pagina:
          type: number
          description: Pagina retornada dos dados
          example: 0
        limite:
          type: number
          description: Quantidade de itens retornados na consulta
          example: 10
        total:
          type: number
          description: Quantidade total de unidades para consultar
          example: 5
        unidades:
          description: Resultado da consulta
          type: array
          items:
            $ref: '#/components/schemas/PaymentSheetCollaboratorDto'
      required:
        - pagina
        - total
        - unidades
    ErrorDto:
      type: object
      properties:
        service:
          type: string
          description: Rota solicitada
        method:
          type: string
          description: Método http
        message:
          description: Mensagem do erro
          oneOf:
            - type: string
              example: message erro
            - type: array
              items:
                type: string
                example:
                  - erro 1
                  - erro 2
      required:
        - service
        - method
        - message
    PaymentSheetCollaboratorDto:
      type: object
      properties:
        id:
          type: string
          description: ID do colaborador
          example: 123-456abc
        code:
          type: number
          description: Código numérico do colaborador
          example: 7
        name:
          type: string
          description: Nome do colaborador
          example: Fulano de Tal
        documentNumber:
          type: string
          description: CPF ou CNPJ do colaborador
          example: '15621118054'
        internalRegistration:
          type: string
          description: Matrícula interna do colaborador
          example: '49172594718'
        photo:
          type: string
          description: Url para download da foto
          example: https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg
        businessUnit:
          description: Unidade de negócio do colaborador
          allOf:
            - $ref: '#/components/schemas/PaymentSheetExportBusinessUnitDto'
      required:
        - id
        - code
        - name
        - documentNumber
    PaymentSheetExportBusinessUnitDto:
      type: object
      properties:
        id:
          type: string
          description: ID da unidade de negócio
          example: 123-456abc
        name:
          type: string
          description: Nome da unidade de negócio
          example: Fulano de Tal
        documentNumber:
          type: string
          description: CPF ou CNPJ da unidade de negócio
          example: '15621118054'
        documentNumberType:
          type: string
          description: Tipo do número de documento da unidade de negócio
          enum:
            - CNPJ
            - CPF
          default: CNPJ
        complementaryRegistration:
          type: string
          description: Cadastro complementar da unidade de negócio
          example: '15621118054'
        complementaryRegistrationType:
          type: string
          description: Tipo de cadastro complementar da unidade de negócio
          enum:
            - CNPJ
            - CPF
          default: CNPJ
        photo:
          type: string
          description: Url para download da foto
          example: https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg
      required:
        - id
        - name
        - documentNumber
        - documentNumberType

````