---
title: "Listar sócios - PF"
method: GET
path: "/clients/{onboarding_id}/partners/people"
---

# Listar sócios - PF

`GET /clients/{onboarding_id}/partners/people`

## Request

- Base URL: `https://pagamentos.grafeno.be/api/v2`
- URL: `https://pagamentos.grafeno.be/api/v2/clients/{onboarding_id}/partners/people`
- Auth: HTTP basic and API key in header `Authorization`
- TypeScript: <https://skmtc.dev/grafeno/apis/api-v2-grafeno/docs/clients/:onboarding_id/partners/people/get.ts> (a function with typed inputs; its response is checked against the schema)

Lista todos os sócios PF de determinado onboarding.

## Path parameters

- `onboarding_id` string, required

## Query parameters

- `p[per_page]` string
- `p[page]` string
- `s[]` 'asc' | 'desc'
- `q[idEq]` string
- `q[parentCompanyIdEq]` string
- `q[documentNumberContNumbers]` string
- `q[nameCont]` string
- `q[emailCont]` string

## Response `200`

200

- object
  - `data` object[]
    - `id` string
    - `type` string
    - `attributes` object
      - `documentNumber` string
      - `parentCompanyId` string
      - `name` string
      - `email` string
      - `shareCapital` string
      - `sharePercent` string
  - `meta` object
    - `search` object
    - `pagination` object
      - `currentPage` integer
      - `previousPage` unknown
      - `nextPage` unknown
      - `perPage` integer
      - `totalPages` integer
      - `totalCount` integer

## Other responses

- `400`: 400
- `401`: 401

---

[API](https://skmtc.dev/grafeno/apis/api-v2-grafeno.md) - [All operations](https://skmtc.dev/grafeno/apis/api-v2-grafeno/llms.txt) - [OpenAPI document](https://skmtc.dev/grafeno/apis/api-v2-grafeno/revisions/20f928f6933f?raw)