v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
Admin

Returns all workspaces with detailed information on each workspace, if the requesting user is staff.

get/api/admin/workspaces/

Query parameters

idsstring

A comma-separated list of workspaces IDs to filter by. When provided, only workspaces with those IDs are returned.

pageinteger

Defines which page should be returned.

searchstring

If provided only workspaces with id or name that match the query will be returned.

sizeinteger

Defines how many workspaces should be returned per page.

sortsstring

A comma separated string of attributes to sort by, each attribute must be prefixed with + for a descending sort or a - for an ascending sort. The accepted attribute names are: id, name, application_count, created_on, row_count, storage_usage. For example sorts=-id,-name will sort the workspaces first by descending id and then ascending name. A sortparameter with multiple instances of the same sort attribute will respond with the ERROR_INVALID_SORT_ATTRIBUTE error.

Response

countinteger required

The total amount of results.

nextstring uri nullable required

URL to the next page.

previousstring uri nullable required

URL to the previous page.