---
title: "Get the list of documents."
method: GET
path: "/api/v2/bridge/documents"
tags: ["Black Kite Bridge"]
---

# Get the list of documents.

`GET /api/v2/bridge/documents`

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

## Query parameters

- `page_number` integer
- `page_size` 10 | 20 | 30

## Response `200`

Success

- BlackKiteBridgeDocument[]
  - `DocumentId` integer
  - `Company` BlackKiteBridgeCompany
    - `Id` integer
    - `Name` string
  - `ReportName` string
  - `CreatedDate` string, date-time — The create date of this document.
  - `SharedDate` string, date-time — The shared date of this document.
  - `SharingStatus` 'Active' | 'Deleted' | 'Stopped', nullable — The sharing progress status of the shared document.
  - `SharedInfo` BlackKiteBridgeSharedInfo
    - `Tenant` string — The name of the tenant that shared with.
    - `Direction` 'Outbound' | 'Inbound', nullable — The sharing direction of the shared document.

## Other responses

- `401` — Unauthorized
- `default` — Failure

---

[API](https://skmtc.net/blackkitetech/apis/black-kite-api.md) · [All operations](https://skmtc.net/blackkitetech/apis/black-kite-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/blackkitetech/black-kite-api/revisions/7dadaba760fb/schema)