List workspaces

Note: Archived workspaces are not part of the list being returned. You may filter the list by providing query string parameters like name and/or externalRef. Pagination is supported via page and pageSize query string parameters. Default page size is 100.

Path Parameters

• organisation-id cuid required

  Organisation ID

Query Parameters

• keyword string

  Keyword to use to search for rooms

• externalRef string

  External reference linked to the room

• pageSize int32

  Possible values: >= 10 and <= 100

  Number of items to return per page

• page int32

  Possible values: >= 1

  Page to return

Responses

• 200
• default

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• total int32
• page int32
• data object[]

{
  "total": 0,
  "page": 0,
  "data": [
    {
      "name": "string",
      "externalRef": "string",
      "slug": "string",
      "ownerUserEmail": "string",
      "createdAt": "2023-04-13",
      "updatedAt": "2023-04-13",
      "archivedAt": "2023-04-13",
      "id": "string"
    }
  ]
}

Unexpected error

application/json

• Schema
• Example (from schema)

---

Schema

• code string
• message string

{
  "code": "string",
  "message": "string"
}

Loading...