> ## Documentation Index
> Fetch the complete documentation index at: https://juridiqsoftware.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar pessoas vinculadas ao parceiro financeiro



## OpenAPI

````yaml https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/partners/{id}/people
openapi: 3.1.0
info:
  title: Juridiq API — Documentação para Integradores
  description: >-
    API REST para integradores autenticados com chave (`x-juridiq-api-key`).


    ## Rate limit


    A API aberta limita **120 requisições a cada 60s por chave**.

    Ao exceder, a resposta é `429 Too Many Requests` com os headers
    `x-ratelimit-limit`, `x-ratelimit-remaining`, `x-ratelimit-reset` e
    `retry-after`.

    Respeite o `retry-after` antes de tentar de novo. Sincronizações em lote
    devem paginar e tratar 429 com backoff.
  version: 1.0.0
servers:
  - url: https://api.juridiq.com.br
    description: Production server
security:
  - apiKeyAuth: []
tags: []
paths:
  /financial/partners/{id}/people:
    get:
      tags:
        - Financial
      summary: Listar pessoas vinculadas ao parceiro financeiro
      parameters:
        - schema:
            type: string
          in: query
          name: page
          required: false
          description: Página (default 1)
        - schema:
            type: string
          in: query
          name: limit
          required: false
          description: Itens por página (default 30)
        - schema:
            type: string
          in: query
          name: search
          required: false
          description: Busca por nome, documento, e-mail ou telefone
        - schema:
            type: string
            enum:
              - cliente
              - parte adversa
          in: query
          name: personOrigin
          required: false
          description: Filtro por origem da pessoa
        - schema:
            type: string
            enum:
              - partnerLinkedAt
              - name
          in: query
          name: orderByField
          required: false
          description: Campo de ordenação (default partnerLinkedAt)
        - schema:
            type: string
            enum:
              - asc
              - desc
          in: query
          name: orderBy
          required: false
          description: Direção (default desc)
        - schema:
            type: string
            format: uuid
          in: path
          name: id
          required: true
          description: ID do parceiro
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: ID da pessoa
                        name:
                          type: string
                          description: Nome
                        document:
                          type: string
                          nullable: true
                          description: Documento
                        personType:
                          type: string
                          nullable: true
                          description: PF ou PJ
                        personOrigin:
                          type: string
                          nullable: true
                          description: >-
                            Nome do tipo de pessoa no catálogo (Cliente,
                            Requerida…)
                        email:
                          type: string
                          nullable: true
                          description: E-mail
                        phone:
                          type: string
                          nullable: true
                          description: Telefone
                        partnerLinkedAt:
                          anyOf:
                            - type: string
                            - type: string
                              format: date-time
                          description: Data do vínculo com o parceiro
                        linkedLawsuitCount:
                          type: number
                          description: Processos em que a pessoa e o parceiro coexistem
                      required:
                        - id
                        - name
                        - document
                        - personType
                        - personOrigin
                        - email
                        - phone
                        - partnerLinkedAt
                        - linkedLawsuitCount
                      additionalProperties: false
                    description: Pessoas vinculadas ao parceiro
                  totalItems:
                    type: number
                    description: Total de registros
                  totalPages:
                    type: number
                    description: Total de páginas
                  page:
                    type: number
                    description: Página atual
                  limit:
                    type: number
                    description: Itens por página
                required:
                  - data
                  - totalItems
                  - totalPages
                  - page
                  - limit
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  translateMessage:
                    type: string
                required:
                  - message
                  - statusCode
                  - translateMessage
                additionalProperties: false
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-juridiq-api-key
      description: >-
        Chave de API do escritório (criada no painel). Envie o valor no header
        x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a
        documentação de integradores).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.