v2

latestOpenAPI 3.0.02026-08-013312111.4 MB

Workspaces

List workspaces for the current user

Returns an object for each workspace accessible to the caller. This object also contains details on whether the caller has admin permissions on the workspace ("administrator" = true) or not ("administrator" = false).

Queries support filtering based on administrator permissions, sorting or filtering by slug. Results can be paginated.

get/user/workspaces

Query parameters

sortstring

Name of a response property to sort results (only slug is supported).

administratorboolean

Filter workspaces based on which ones the caller has admin permissions or not.

Response

The list of workspaces accessible by the authenticated user.

sizeinteger

Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

pageinteger

Page number of the current results. This is an optional element that is not provided in all responses.

pageleninteger

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

nextstring uri

Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

previousstring uri

Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.