DataRoomDocumentIndex

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.

type DataRoomDocumentIndex {
  dataRoom: DataRoom!
  items(
    folderIds: [ID!]
    first: Int
    after: String
  ): DataRoomDocumentIndexItemsConnection
  id: ID!
}

Fields

DataRoomDocumentIndex.dataRoom ● DataRoom! non-null object

The DataRoom associated with this document index.

DataRoomDocumentIndex.items ● DataRoomDocumentIndexItemsConnection object

A paginated list of document index items (documents or folders) within the Data Room.

DataRoomDocumentIndex.items.folderIds ● [ID!] list scalar

Filter the index to specific folders. If not provided, return root-level items.

DataRoomDocumentIndex.items.first ● Int scalar

Returns the first n elements from the list.

DataRoomDocumentIndex.items.after ● String scalar

Returns the elements in the list that come after the specified cursor.

DataRoomDocumentIndex.id ● ID! non-null scalar

The unique identifier for the document index.

Returned By

dataRoomDocumentIndex query