Sign in

v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB
Black Kite Bridge

Get details of a shared document on the Black Kite Bridge.

Get the information of document that shared on the Black Kite Bridge.

get/api/v2/bridge/documents/{id}

Path parameters

idinteger required

The id of a document that shared on the Black Kite Bridge.

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"
  }
}