Workspaces API

List workspaces

GET

/workspace/orgs/{org_id}/workspaces

Returns a paginated list of all workspaces that you have a role to access in your organization. For a list of all workspaces regardless of your user role, see the 'Admin' equivalent API.

Request

Path parameters

org_iduuid

Required

Query parameters

limitinteger | null

Default: 20

The maximum number of results to return. Limits over 100 are deprecated and will eventually not be supported.

offsetinteger | null

The (zero-based) offset of the first item returned in the collection.

sortstring | null

Deprecated

An optional comma separated list of fields to sort the results by. Options are: name, -name, created_at, -created_at, updated_at, -updated_at, user_role, -user_role.

order_bystring | null

An optional, comma-separated list of fields by which to order the results. Each field could be prefixed with an order operator: asc: for ascending order or desc: for descending order, default is ascending order. The sortable fields are: name, created_at, updated_at, and user_role.

filter[created_by]string | null

Filter by workspace that a user has created, by user ID.

created_atstring | null

Filter by the time workspace has created.

updated_atstring | null

Filter by the latest time workspace was updated.

filter[name]string | null

Deprecated

Filter by workspace name.

namestring | null

Filter by workspace name.

deletedboolean | null

Include workspaces that have been deleted.

filter[user_id]string | null

Filter by workspaces that a user ID has access to.

Responses

200

Successful Response

Response schema

linksPaginationLinks

countinteger

firsturi

lasturi

nextstring | null

previousstring | null

totalinteger

resultsarray | array

Any of:

array

401

No permission -- see authorization schemes

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

403

Request forbidden -- authorization will not help

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

404

Resource not found or user lacks access

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

405

Specified method is invalid for this resource

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

422

Unprocessable Entity

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring