Skip to main content
GET
/
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
}

Query Parameters

pageInfo
object

the page info

order
object

the sort options

parentBrokerageFirmId
string

Response

200 - application/json

Paginated list of brokerage firms.

data
object[]
required

the list of items in the page

pageInfo
object
required

the page info

totalCount
number
required

the total number of items

currentPage
number
required

the current page

totalPages
number
required

the total number of pages