Try it free

List environment shares

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

List environment shares accessible to you in Dynatrace with the Document API, with optional filtering and pagination for document access.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/document/v1/environment-shares

Overview

List all environment-shares accessible to you. Shares accessible to you include those of your own documents, as well as those of reshareable documents owned by other users to which you have write access. If you are only concerned with a specific document's environment-shares, or a specific share, you can use the filter parameter to narrow down the result set. If you attempt to retrieve environment-shares of a document not accessible by you, the result set will be empty.

Furthermore, you can apply pagination via the pageKey, page and pageSize parameters.

Note, that at the moment we offer a naive pagination, and therefore interim mutations can lead to result inconsistencies (such as duplicates, missing entries).

Authentication

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

Parameters

ParameterTypeDescriptionInRequired
filterstring

The filter query, as explained here. Filtering is only possible on the documentId property, and only via the equals operator. Via this you can effectively retrieve the environment-shares of a specific document. If this parameter is omitted, all environment-shares accessible to you will be returned.

queryOptional
page-keystring

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.

queryOptional
pageinteger

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.

queryOptional
page-sizeinteger

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.

queryOptional

Response

Response codes

CodeTypeDescription
200EnvironmentShareList

A list of the environment-shares accessible to you. If the list was paginated (see pageKey, page and pageSize), and there are more environment-shares available, you will find a non-empty nextPageKey which can be used for a follow-up query. The totalCount property will let you know the number of all matching environment-shares, as if no pagination would have been applied.

400--
401--
403--
500--
503--
default--

Response body objects

The EnvironmentShareList object

A list of environment-shares.

ElementTypeDescription
environment-sharesEnvironmentShare[]-
nextPageKeystring

Use this as page-key query param to get the next page. If the list was paginated, and there are more results available, this parameter will be returned.

totalCountinteger

The total amount of matching results for this query, as if no pagination would have been applied.

The EnvironmentShare object

ElementTypeDescription
idstring

System-generated id of a share resource.

documentIdstring

The shared document's id.

accessstring[]

Indicates which operations you may apply to this document. For example, if you own the document, this array contains the values ['read', 'write', 'delete'].

  • read - you may read, but not update or delete it.
  • write - you may update, but not read or delete it.
  • delete - you may delete, but not read or update it.
claimCountinteger

Number of users who have claimed this share and therefore can access the document and collaborate on it.

Response body JSON models

{
"environment-shares": [
{
"id": "af21cc73-bb1c-45f1-ad1b-12e8f91b9fbc",
"documentId": "1d1cf013-fd4c-463e-a8ad-912485daf711",
"access": [
"read"
],
"claimCount": 5
},
{
"id": "f0ed12ec-f232-45db-b667-26b2cf414787",
"documentId": "1d1cf013-fd4c-463e-a8ad-912485daf711",
"access": [
"read",
"write"
],
"claimCount": 0
},
{
"id": "9dc638d0-0cea-4c9c-ad9c-85ec02d967d6",
"documentId": "4f135fa6-0c1b-456d-b962-20f14a2ac67e",
"access": [
"read",
"write"
],
"claimCount": 42
}
],
"nextPageKey": "bmQgUXVhcms=",
"totalCount": 42
}
Related tags
Platform APIDynatrace Platform