List accessible documents

Latest Dynatrace
Reference
Published Oct 13, 2026

List accessible documents in Dynatrace with the Document API, returning metadata for your own and shared documents with filtering and paging.


GET	SaaS	`https://{your-environment-id}.apps.dynatrace.com/platform/document/v1/documents`

Overview

You use filter, sort, page-key, page, page-size, admin-access, and add-fields to shape the result set. The response returns a list of document metadata objects accessible to you, including your own documents and documents shared with you.

Authentication

To execute this request, you need a platform token or OAuth access token with document:documents:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
filter	string	The filter parameter, as explained here. If this parameter is omitted, no filtering is applied and all documents available to you will be returned. Filtering by string type parameters (`name`, `type`) when using one of the operators `contains`, `starts-with` and `ends-with` is case insensitive. Filtering by `id` using the operators `contains`, `starts-with` and `ends-with` is only supported in case of user-given document ids. When using the equals operator or the not-equals operator, filtering is case sensitive. The following fields are legal filtering parameters - any other field names will result in a HTTP 400 response: `id`, `name`, `type`, `version`, `owner`, `modificationInfo.createdTime`, `modificationInfo.createdBy`, `modificationInfo.lastModifiedTime`, `modificationInfo.lastModifiedBy`, `originAppId`, `originExtensionId`, `isPrivate`, `labels`, `userContext.isFavorite` The following constraints apply: Parameter names are case-sensitive. Maximum nesting depth (via brackets) is 3. Maximum length is 1024 characters. The `labels` field only supports the `contains` operator, which checks whether the document has a specific label assigned. This is an exact element match against the labels array. It's not a substring search. For example, `labels contains 'foo'` matches a document with the label `'foo'`, but not a document with the label `'foobar'`. To find labels by partial name (substring), use the `listLabels` operation. The `userContext.isFavorite` field only supports the `=` operator. Use `userContext.isFavorite = true` to list only documents you have marked as favorites. Note: filtering on this field does not require requesting it via `add-fields`. Examples: `name = 'my-document-name'` `name == 'my-document-name'` `(name starts-with 'awesome' or type != 'dashboard') and version >= 5` `modificationInfo.lastModifiedTime >= '2022-07-01T00:10:05.000Z' and not (name contains 'new')` `originAppId exists` `originExtensionId exists` `type in ('dashboard', 'notebook') and name contains 'report'` `isPrivate = true` `labels contains 'my-label'` `labels contains 'my-label' and labels contains 'other-label'` `userContext.isFavorite = true`	query	Optional
sort	string	The sort parameter, as explained here If this parameter is omitted, the documents are sorted by their ids. Sorting by string types (`name`, `type`) is done in a case insensitive manner. The following fields are legal sorting parameters - any other sorting parameters will result in a HTTP 400 response: `name`, `type`, `version`, `owner`, `modificationInfo.createdTime`, `modificationInfo.createdBy`, `modificationInfo.lastModifiedTime`,`modificationInfo.lastModifiedBy`,`originAppId`, `userContext.lastAccessedTime`, `userContext.isFavorite` The following constraints apply: Maximum number of sorting parameters is 5. Exceeding this limit will result in a HTTP 400 response. Note that blanks are not ignored and will result in a HTTP 400 response. Examples: `name` `name,-type,modificationInfo.lastModifiedTime`	query	Optional
page-key	string	The page key is used to query results from the next page. You get a `nextPageKey` parameter in the return value of this method to use here. If this parameter is omitted, the first page will be returned.	query	Optional
page	integer	The page parameter is used to directly access a specific page. The value of the page parameter, if specified, has to be a value greater than zero. If the value of the page parameter exceeds the highest available page on the backend, an empty page is returned.	query	Optional
page-size	integer	The page size which defines the requested number of result entries. You can request a maximum of 1000 result entries. If this parameter is omitted, the default value of 20 will be used.	query	Optional
admin-access	boolean	Indicates whether the operation should be performed with elevated permissions - additionally requires document:documents:admin. If provided, the user effectively operates as owner of all documents. This isn't supported for ready-made documents.	query	Optional
add-fields	string	Comma-separated list of field names that are added to the default set of fields. You can include the following additional fields: `description` `userContext.lastAccessedTime` `userContext.isFavorite` `originExtensionId` `shareInfo.isShared` `shareInfo.isSharedWithCurrentUser` `labels`	query	Optional

Response

Response codes

Code	Description
200	-
400	-
401	-
403	-
500	-
503	-
default	-

GET

SaaS

https://{your-environment-id}.apps.dynatrace.com/platform/document/v1/documents

Parameters

Parameter	Type	Description	In	Required
filter	string	The filter parameter, as explained here. If this parameter is omitted, no filtering is applied and all documents available to you will be returned. Filtering by string type parameters (`name`, `type`) when using one of the operators `contains`, `starts-with` and `ends-with` is case insensitive. Filtering by `id` using the operators `contains`, `starts-with` and `ends-with` is only supported in case of user-given document ids. When using the equals operator or the not-equals operator, filtering is case sensitive. The following fields are legal filtering parameters - any other field names will result in a HTTP 400 response: `id`, `name`, `type`, `version`, `owner`, `modificationInfo.createdTime`, `modificationInfo.createdBy`, `modificationInfo.lastModifiedTime`, `modificationInfo.lastModifiedBy`, `originAppId`, `originExtensionId`, `isPrivate`, `labels`, `userContext.isFavorite` The following constraints apply: Parameter names are case-sensitive. Maximum nesting depth (via brackets) is 3. Maximum length is 1024 characters. The `labels` field only supports the `contains` operator, which checks whether the document has a specific label assigned. This is an exact element match against the labels array. It's not a substring search. For example, `labels contains 'foo'` matches a document with the label `'foo'`, but not a document with the label `'foobar'`. To find labels by partial name (substring), use the `listLabels` operation. The `userContext.isFavorite` field only supports the `=` operator. Use `userContext.isFavorite = true` to list only documents you have marked as favorites. Note: filtering on this field does not require requesting it via `add-fields`. Examples: `name = 'my-document-name'` `name == 'my-document-name'` `(name starts-with 'awesome' or type != 'dashboard') and version >= 5` `modificationInfo.lastModifiedTime >= '2022-07-01T00:10:05.000Z' and not (name contains 'new')` `originAppId exists` `originExtensionId exists` `type in ('dashboard', 'notebook') and name contains 'report'` `isPrivate = true` `labels contains 'my-label'` `labels contains 'my-label' and labels contains 'other-label'` `userContext.isFavorite = true`	query	Optional
sort	string	The sort parameter, as explained here If this parameter is omitted, the documents are sorted by their ids. Sorting by string types (`name`, `type`) is done in a case insensitive manner. The following fields are legal sorting parameters - any other sorting parameters will result in a HTTP 400 response: `name`, `type`, `version`, `owner`, `modificationInfo.createdTime`, `modificationInfo.createdBy`, `modificationInfo.lastModifiedTime`,`modificationInfo.lastModifiedBy`,`originAppId`, `userContext.lastAccessedTime`, `userContext.isFavorite` The following constraints apply: Maximum number of sorting parameters is 5. Exceeding this limit will result in a HTTP 400 response. Note that blanks are not ignored and will result in a HTTP 400 response. Examples: `name` `name,-type,modificationInfo.lastModifiedTime`	query	Optional
page-key	string	The page key is used to query results from the next page. You get a `nextPageKey` parameter in the return value of this method to use here. If this parameter is omitted, the first page will be returned.	query	Optional
page	integer	The page parameter is used to directly access a specific page. The value of the page parameter, if specified, has to be a value greater than zero. If the value of the page parameter exceeds the highest available page on the backend, an empty page is returned.	query	Optional
page-size	integer	The page size which defines the requested number of result entries. You can request a maximum of 1000 result entries. If this parameter is omitted, the default value of 20 will be used.	query	Optional
admin-access	boolean	Indicates whether the operation should be performed with elevated permissions - additionally requires document:documents:admin. If provided, the user effectively operates as owner of all documents. This isn't supported for ready-made documents.	query	Optional
add-fields	string	Comma-separated list of field names that are added to the default set of fields. You can include the following additional fields: `description` `userContext.lastAccessedTime` `userContext.isFavorite` `originExtensionId` `shareInfo.isShared` `shareInfo.isSharedWithCurrentUser` `labels`	query	Optional

Code

Description

200

400

401

403

500

503

default