Developer APIResources

Workspace details

Use this API to get details about your workspace.

ENDPOINT ACCESS

Your API client must be assigned privilege for the Get workspace details endpoint. This privilege is determined by your API client.

Additionally, if your workspace uses environments, this privilege is only available to API clients with DEV access.

You can enable access to these endpoints by editing an existing API client role or by creating a new API client role:

1

Navigate to Workspace admin > API clients > Client roles.

Select the role you plan to edit.

Alternatively, click + Add client role to create a new API client role.

2

Select Admin and navigate to Workspace details > Workspace details.

3

Select the checkbox next to the Get details GET /api/users/me endpoint.

Select the endpoints you plan to enable

Select the endpoints you plan to enable

Quick reference

TypeResourceDescription
GET/api/users/meGet authenticated user details