Skip to navigation
AgentFS APIAgent Filesystem

Agents Get

Preview
View as Markdown

Returns one of the authenticated user’s agents and its explicit workspace rules.

Required scope: private:agent_filesystem.agents.manage

Endpoint format: RPC

Authentication: User

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

Authentication

AuthorizationBearer

OAuth 2.0 token issued to a specific user. Use Authorization: Bearer <token>.

Public clients should use the authorization code flow with PKCE (S256).

For background or offline access, send token_access_type=offline during authorization and use the returned refresh token to obtain new access tokens.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

Headers

Dropbox-API-Select-UserstringOptional

Acts on behalf of a team member for supported user-auth operations. Pass a team member ID such as dbmid:.... When used with a team token, that token must also include the team_data.member scope.

Dropbox-API-Path-RootstringOptional

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the common.PathRoot union: {".tag": "home"}, {".tag": "root", "root": "<namespace_id>"}, or {".tag": "namespace_id", "namespace_id": "<namespace_id>"}. On failure the request returns 422 with a common.PathRootError.

Request

This endpoint expects an object.
agentobjectRequired
Agent to retrieve.
Variant:
agent_filesystem.AgentSelector.agent_idobjectRequired
Selects the agent by its Agent Filesystem ID.

Response headers

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

Response

Successful response
agent_idstring1-256 characters
Agent Filesystem ID for the agent.
owner_user_public_idstring1-256 characters
Public user ID of the agent's owner, bound to the Provider app.
workspaceobject
File and folder access rules assigned to the agent.

Errors

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