Browse Document Index

Objective

List documents and folders in a DataRoom, starting from the root or a specific folder.

Browse Document Index

Returns a list of documents and folders in a DataRoom. If folder IDs are not provided, the root folder of the DataRoom will be returned.

info

This operation require the DataRoom-scoped token.

tip

The query only returns folders and documents one level below the specified folder (or root). To retrieve all folders and documents in a DataRoom, clients must recursively query each folder that has children until all have been visited.

# Returns all folders & documents of the root folder (one level deep).
query BrowseDocumentIndexRootQuery {
  dataRoomDocumentIndex(dataRoomId: "RGF0YVJvb206MTIz") {
    items {
      nodes {
        __typename
        name
        number
        status
        createdDate
        lastModifiedDate
        ... on DataRoomDocument {
          id
          file {
            extension
            size
          }
        }
        ... on DataRoomFolder {
          id
          hasChildren
        }
      }
    }
  }
}

# Returns all folders & documents of the specified sub folders (one level deep).
query BrowseDocumentIndexSubFoldersQuery {
  dataRoomDocumentIndex(dataRoomId: "RGF0YVJvb206MTIz") {
    items(folderIds: ["RGF0YVJvb21Gb2xkZXI6MQ==", "RGF0YVJvb21Gb2xkZXI6Mg=="]) {
      nodes {
        __typename
        name
        number
        status
        createdDate
        lastModifiedDate
        ... on DataRoomFolder {
          id
          hasChildren
        }
        ... on DataRoomDocument {
          id
          file {
            extension
            size
          }
        }
      }
    }
  }
}