v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB

Black Kite Bridge

Get the list of documents.

Get a list of documents that shared on the Black Kite Bridge.

get/api/v2/bridge/documents

Query parameters

page_numberinteger

Example:1

The number of the page requested.

page_size10 | 20 | 30

Example:10

The number of result items in a single response.

Response

Success

DocumentIdinteger

ReportNamestring

CreatedDatestring date-time

The create date of this document.

SharedDatestring date-time

The shared date of this document.

SharingStatus'Active' | 'Deleted' | 'Stopped' nullable

The sharing progress status of the shared document.

Example response

[
  {
    "DocumentId": 45,
    "Company": {
      "Id": 45,
      "Name": "Acme Inc."
    },
    "ReportName": "My Report",
    "CreatedDate": "2021-08-09T08:30:30.682Z",
    "SharedDate": "2021-08-09T08:30:30.682Z",
    "SharingStatus": "Active",
    "SharedInfo": {
      "Tenant": "Acme, Inc.",
      "Direction": "Inbound"
    }
  }
]