Paginated query of investors by fund class
Returns, in paginated form, the investors that have a financial application linked to the given fund class (through issuance series and sub classes). Allows filtering by document, name and closing date.
Available on
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Read |
Base URL for each host: Environments (Hosts).
Request
ENDPOINT
/quota/fund_class/{fund_class_key}/investorsMETHOD
GETQuery params
| Parameter | Type | Requirement | Description |
|---|---|---|---|
page | integer | optional | Page number (starts at 0). Default: 0. |
limit | integer | optional | Records per page. Default: 20. Maximum: 500. |
document_number | string | optional | Filters by the investor's document, with punctuation. |
name | string | optional | Part of the investor's name (case-insensitive). |
reference_date | string (date) | optional | Returns only investors with a financial application closing on this accounting date (YYYY-MM-DD). |
Example call
GET /quota/fund_class/{fund_class_key}/investors?page=0&limit=25&reference_date=2024-04-01
Response
STATUS
200Response Body
{
"data": [
{
"distributor": {
"distributor_key": "3571e292-3a83-4011-904d-20ee963022ef",
"document_number": "11.222.333/0001-81",
"name": "Distribuidora Exemplo S.A.",
"account_data": {
"owner": {
"name": "Distribuidora Exemplo S.A.",
"document_number": "11.222.333/0001-81"
},
"account_digit": "1",
"account_branch": "0001",
"account_number": "12345",
"financial_institution_code": "341",
"financial_institution_ispb": "60746948"
}
},
"investor_key": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Maria Cotista Silva",
"person_type": "natural_person",
"document_number": "969.698.790-03",
"external_id": "ext-inv-001",
"external_distribution_key": null
},
{
"distributor": {
"distributor_key": "3571e292-3a83-4011-904d-20ee963022ef",
"document_number": "11.222.333/0001-81",
"name": "Distribuidora Exemplo S.A.",
"account_data": {
"owner": {
"name": "Distribuidora Exemplo S.A.",
"document_number": "11.222.333/0001-81"
},
"account_digit": "1",
"account_branch": "0001",
"account_number": "12345",
"financial_institution_code": "341",
"financial_institution_ispb": "60746948"
}
},
"investor_key": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Investimentos PJ Ltda",
"person_type": "legal_person",
"document_number": "22.333.444/0001-81",
"external_id": null,
"external_distribution_key": "dist-key-7721"
}
],
"limit": 20,
"page": 0,
"is_last_page": true
}
Response attributes
| Field | Type | Description |
|---|---|---|
data | array | List of investors. |
page | integer | Current page. |
limit | integer | Page size. |
is_last_page | boolean | Indicates the end of pagination. |
Fields of each investor in data
| Field | Type | Description |
|---|---|---|
investor_key | string | Unique identifier of the investor (UUID). |
name | string | Name. |
person_type | string | Person type (enumerator, e.g. natural_person, legal_person). |
document_number | string | Document, when available. |
distributor | object | Distributor data (distributor_key, document_number, name, account_data). |
external_id | string | Optional — external identifier. |
external_distribution_key | string | Optional — external distribution key. |
Errors
| Status | Code | When it happens |
|---|---|---|
| 400 | QIT000004 | The fund does not belong to the manager |
| 404 | QTA000002 | Fund class not found |
Authentication, permission and host errors: see API Errors.