cURL
curl --request GET \ --url https://api.example.com/brokerage-firms
{ "data": [ { "type": "<string>", "firmType": "WHOLESALE", "id": "<string>", "companyInfo": { "siret": "<string>", "siren": "<string>", "nafCode": "<string>", "nafLabel": "<string>", "name": "<string>", "creationDate": "<string>", "location": { "city": "<string>", "country": "<string>", "address": "<string>", "postCode": "<string>" }, "legalStatus": { "1": "<string>", "2": "<string>", "3": "<string>" }, "headcount": "<string>" }, "createdAt": "2023-11-07T05:31:56Z", "tenantId": "<string>", "customFields": [ { "key": "<string>", "value": "<string>" } ], "parentBrokerageFirmId": "<string>" } ], "pageInfo": { "first": true, "last": true }, "totalCount": 123, "currentPage": 123, "totalPages": 123 }
Returns a paginated list of brokerage firms in the current tenant. Results may vary by user permissions.
the page info
Show child attributes
the sort options
Paginated list of brokerage firms.
the list of items in the page
the total number of items
the current page
the total number of pages
Was this page helpful?