Skip to main content
GET
/
brokerage-firms
/
{brokerageFirmId}
/
documents
{
  "data": [
    {
      "metadata": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "id": "<string>",
      "name": "<string>",
      "path": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "signedUrl": "<string>"
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

Path Parameters

brokerageFirmId
string
required

the brokerageFirm id

Query Parameters

pageInfo
object

the page info

order
object

the sort options

categories
string[]

Response

Documents listed successfully.

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