workspaces

List the current user’s workspaces

Changed on
get/workspaces

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

offsetnumber
limitnumber
sort'updatedAt' | 'createdAt' | 'name'
searchstring

Response

A page of workspaces ordered by the requested sort

Example response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Bürgeranfragen",
      "description": "Anfragen von Bürgerinnen und Bürgern bündeln",
      "instruction": "Answer with the tone and policies of the building department.",
      "icon": "landmark",
      "color": "#6b5bd6",
      "createdAt": "2026-08-11T10:00:00.000Z",
      "updatedAt": "2026-08-11T10:30:00.000Z",
      "chatCount": 3,
      "skillCount": 2,
      "knowledgeBaseCount": 4,
      "lastActivityAt": "2026-08-11T10:30:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "total": 150
  }
}

Changes

  • 761449ed9ef3Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • e2af65d3c5b1Revision changes
    • breaking

      the response's body type changed from array to object for status

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter sort

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status