v4

latestSwagger 2.02026-08-0343714211.7 MB
workspaces
Workspaces

List Workspaces

List Workspaces

get/workspaces

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are name.

If set, return records where the specified field is equal to the supplied value. Valid fields are name.

If set, return records where the specified field is prefixed by the supplied value. Valid fields are name.

Response

A list of Workspaces objects.

idinteger

Workspace ID

namestring

Workspace name

Example response

[
  {
    "id": 1,
    "name": "Project Alpha"
  }
]