v1

latestOpenAPI 3.1.12026-07-124448163.2 KB

workspaces

Get a workspace

Returns a single workspace by ID.

get/workspaces/{id}

Path parameters

idstring cuid required

The ID of the item

Example:cmf41ajzv003706un4i99q19z

Headers

x-client-idstring cuid required

The ID of the client

Example:cmf41ajzv003706un4i99q19z

Response

Workspace

idstring cuid required

The ID of the workspace

namestring required

The name of the workspace

createdAtstring date-time required

The date and time of the creation for the workspace. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

updatedAtstring date-time required

The date and time of the last update for the workspace. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

archivedAtstring date-time nullable required

The date and time the workspace was archived. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

clientIdstring cuid required

The ID of the client

Example response

{
  "id": "cmf41ajzv003706un4i99q19z",
  "name": "FiBu",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
  "archivedAt": "2021-01-01T00:00:00Z",
  "clientId": "cmf41ajzv003706un4i99q19z"
}