workspace

Get Workspace Documents

Retrieve all documents in a workspace with proper access controls. Decrypts document metadata for authorized users.

get/api/workspace/{workspace_ext_id}/documents

Path parameters

workspace_ext_idstring required

Headers

workspace-keystring

Response

Successful Response

external_idstring required

workspace_ext_idstring required

file_namestring nullable

statusstring nullable

n_pagesinteger nullable

n_chunksinteger nullable

tokensinteger nullable

file_typestring nullable

file_sizeinteger nullable

storage_typestring nullable

storage_uristring nullable

sharedboolean nullable

re_ocredboolean nullable

config_ext_idstring nullable

created_by_ext_idstring required

updated_by_ext_idstring nullable

created_atstring date-time required

updated_atstring date-time required

Changes

Changed in 10 of the 34 revisions of this API.3119

Jan 7, 2026249354af19dc1See the full diff
- ○
  added the optional property items/doctags/items/citations to the response with the 200 status
  response-optional-property-added
Jan 6, 20261c863a2a0ea713See the full diff
- ●
  removed the optional property items/doc_metadata/anyOf[subschema #1: DocMetadata]/doc_summary from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property items/doc_metadata/anyOf[subschema #1: DocMetadata]/doc_author to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/doc_metadata/anyOf[subschema #1: DocMetadata]/doc_nature to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/doc_metadata/anyOf[subschema #1: DocMetadata]/doc_subject to the response with the 200 status
  response-optional-property-added
Dec 25, 2025aa4b06f8dede3See the full diff
- ○
  added the optional property items/updated_by_ext_id to the response with the 200 status
  response-optional-property-added
- ○
  the response property items/created_by_ext_id became required for the status 200
  response-property-became-required
- ○
  response property items/created_by_ext_id list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 19, 20257073d86523862See the full diff
- ▲
  removed the required property items/doc_date from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property items/title from the response with the 200 status
  response-required-property-removed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 10, 202511521d46f96b4See the full diff
- ○
  added the optional property items/doc_metadata to the response with the 200 status
  response-optional-property-added
- ○
  the response optional property items/doc_date became read-only for the status 200
  response-optional-property-became-read-only
- ○
  the response property items/doc_date became required for the status 200
  response-property-became-required
- ○
  the response required property items/title became read-only for the status 200
  response-required-property-became-read-only
Dec 3, 202505f131dd000a1See the full diff
- ▲
  removed the required property items/doctags/items/doctag_ext_id from the response with the 200 status
  response-required-property-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 9, 2025dc6f981b30b51See the full diff
- ○
  added the optional property items/doctags to the response with the 200 status
  response-optional-property-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 28, 2025849d5e8732f61See the full diff
- ○
  added the new optional header request parameter workspace-key
  new-optional-request-parameter
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 19, 20255287337ab0fe1See the full diff
- ○
  added the optional property items/config_ext_id to the response with the 200 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 6, 202543c12480eb1b5See the full diff
- ○
  added the optional property items/tokens to the response with the 200 status
  response-optional-property-added
- ○
  the response property items/title became required for the status 200
  response-property-became-required
- ○
  response property items/title list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  added the required property items/created_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/updated_at to the response with the 200 status
  response-required-property-added
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history