Sign in
workspaces

List workspaces

Returns a paginated list of workspaces.

get/workspaces

Query parameters

limitnumber

The number of items to return

Example:20
cursorstring cuid

The cursor to return the next page of items

Example:cmf41ajzv003706un4i99q19z

Headers

x-client-idstring cuid required

The ID of the client

Example:cmf41ajzv003706un4i99q19z

Response

Workspaces

Example response

{
  "data": [
    {
      "id": "cmf41ajzv003706un4i99q19z",
      "name": "FiBu",
      "createdAt": "2021-01-01T00:00:00Z",
      "updatedAt": "2021-01-01T00:00:00Z",
      "archivedAt": "2021-01-01T00:00:00Z",
      "clientId": "cmf41ajzv003706un4i99q19z"
    }
  ],
  "pagination": {
    "nextCursor": "cmf41ajzv003706un4i99q19z",
    "previousCursor": "cmf41ajzv003706un4i99q19z",
    "limit": 20,
    "total": 134
  }
}

Changes

Changed in 1 of the 5 revisions of this API.1

  • 80748f72965e1See the full diff
    • ○

      added the media type application/json for the response with the status 500

      response-media-type-added