workspace

list all workspaces as super admin (require to be super admin)

Changed on
get/workspaces/list_as_superadmin

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/workspaces/list_as_superadmin
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Query parameters

pageinteger

which page to return (start at 1, default 1)

per_pageinteger

number of items to return for a given page (default 30, max 100)

Response

workspaces

idstring required
namestring required
ownerstring required
domainstring
colorstring
parent_workspace_idstring nullable
deletedboolean

Archived (soft-deleted) workspace

is_dev_workspaceboolean
dev_workspace_labelstring nullable

Environment label of the dev workspace, e.g. 'dev' or 'staging'; null defaults to 'dev'

Changes

  • d64d91d392b3Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status