Skip to main content

dataRoomDocumentIndex

Retrieves the document index for a specific Data Room. The index provides a structured, hierarchical view of documents and folders within the Data Room, enabling clients to browse or display its contents efficiently. The index supports pagination and filtering by folder ID via the items field. Use this query to load the document tree for given dataRoomId.

dataRoomDocumentIndex(
  dataRoomId: ID!
): DataRoomDocumentIndex

Arguments​

dataRoomDocumentIndex.dataRoomId ● ID! non-null scalar​

The unique identifier of the Data Room whose document index should be retrieved.

Type​

DataRoomDocumentIndex object​

Represents the indexed structure of documents and folders within a specific Data Room, allowing clients to query for documents and folders with pagination and optional folder-based filtering. This type enables efficient exploration of the Data Room’s contents in a structured, navigable format.