List documents

Returns a paginated list of documents that the user has uploaded or that have been shared with their organization. Use the query parameters documented below for filtering. Use the returned document id with Get document, Get annotated document, or Get original document to retrieve metadata or file content.

GET /contents/v1/documents

List documents

cURL

curl --request GET \
  --url https://api.bigdata.com/contents/v1/documents \
  --header 'X-API-KEY: <api-key>'

200

{
  "results": [
    {
      "id": "E0618D0E9D3A960C1731A620EDE56B5C",
      "file_name": "Weekly summary report.eml",
      "user_id": "user_id_001",
      "org_id": "org_id_001",
      "rp_collection_id": "2CBDC7DA8AE42A8A078DECC3C9FCADFB",
      "raw_size": 18974,
      "request_origin": "email",
      "content_type": "message/rfc822",
      "status": "completed",
      "shared_with_orgs": [
        "org_id_001"
      ],
      "created_at": "2026-02-03T08:43:02.729356Z",
      "updated_at": "2026-02-03T08:43:02.729359Z",
      "published_at": "2026-02-03T08:43:02.729359Z",
      "connector_id": "019a9612-bfad-758c-884e-37dd8c6ad2cb",
      "error_code": null,
      "delete_started_ts": null,
      "file_metadata": null,
      "tags": [
        {
          "id": "019a48b4-e574-71d9-a8d9-6a5a86386847",
          "name": "to:[e-mail]"
        },
        {
          "id": "019a48b4-e573-7203-945a-2e7c4c164217",
          "name": "from:[e-mail]"
        }
      ]
    }
  ]
}

Authorizations

X-API-KEY · string · header · required

Your API key. Include it in every request as the X-API-KEY header. Create and manage keys in the Developer Platform.

Query Parameters

origin · enum<string>

Restrict to documents from this ingestion source: email (email connector), investment_research (broker / investment research connector), or file_upload (direct upload via POST /documents).

Available options: email, investment_research, file_upload

from_date · string<date-time>

Include only documents created on or after this date and time (ISO 8601 format).

ownership · enum<string> · default: all

Restrict to documents by ownership: all (default), only documents you own (owned), or only documents shared with you (shared).

Available options: all, shared, owned

owner · string

Restrict to documents uploaded by this user ID.

page · integer · default: 1

Page number for pagination (1-based). Use with page_size to navigate results.

Required range: x >= 1

page_size · integer · default: 50

Number of documents to return per page (1–100). Default 50.

Required range: 1 <= x <= 100

sort_by · enum<string> · default: created_at

Field used to sort the result set (e.g. created_at, file_name, status).

Available options: created_at, updated_at, file_name, raw_size, content_type, status

sort_order · enum<string> · default: desc

Sort direction: asc (ascending) or desc (descending). Default desc.

Available options: asc, desc

file_name · string

Filter by file name; case-insensitive partial match.

rp_collection_id · string

Restrict to documents in this collection (used for email/attachment grouping).

connector · string

Restrict to documents ingested by this connector (UUID).

tags · string[]

Filter by tag names; documents matching any of the given tags are returned (OR logic).

Response

200

application/json

Paginated list of documents matching the filters. The results array contains document metadata; use each document's id with Get annotated document or Get original document to retrieve file content.

results · object[] · required

Documents in this page. Each item includes id (content_id), file_name, status, connector_id, tags, and timestamps.

Show child attributes