Skip to navigation

Tenants List

Preview
View as Markdown

Coming soon. Lists tenants created by the authenticated app. If the response includes a cursor, pass it to the next request.

Required scope: private:agent_filesystem.tenants.manage

Endpoint format: RPC

Authentication: App

This endpoint does not support apps with the app folder permission.

Authentication

AuthorizationBearer

App-level OAuth 2.0 token (no user context). Use Authorization: Bearer <token>.

Obtain by calling the token endpoint with grant_type=client_credentials.

Only available on endpoints that declare app auth support.

Request

This endpoint expects a nullable object.
pageobject or nullOptional
Pagination controls, when needed.

Response headers

X-Dropbox-Request-IdstringOptional
A unique identifier for the request, useful for debugging and support.

Response

Successful response
tenantslist of objects
Tenants in this page.
next_cursorstring or nullOptional
Present when another page is available.

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error