Skip to main content
POST
/
view-specific
/
{brokerageFirmId}
/
distribution-requests
List distribution requested by the brokerage firm given in the path
curl --request POST \
  --url https://api.example.com/view-specific/{brokerageFirmId}/distribution-requests \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageInfo": {
    "count": 10,
    "page": 1
  },
  "order": {
    "by": "<string>",
    "direction": "<string>"
  }
}
'
{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "status": "PENDING",
      "brokerageFirmId": "<string>",
      "productId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "brokerageFirm": {
        "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
}

Path Parameters

brokerageFirmId
string
required

Query Parameters

statuses
enum<string>[]

Status of the distribution request

Available options:
PENDING,
WAITING_FOR_SIGNATURE,
APPROVED,
DENIED,
REVOKED

Body

application/json
pageInfo
object

the page info

order
object

the sort options

Response

200 - application/json
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