Rust · 0.1.0

List Spaces

GET /api/v1/spaces

SpaceService · SpaceService_ListSpaces

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

Requires authentication and active membership in the relevant space. Instance administrator status does not bypass the space membership boundary.

Request

ListSpaces lists spaces of which the authenticated caller is a member.

GET/api/v1/spaces

Parameters

Name / location	Type / requirement	Description
`pageSize` query	integer (int32) Not marked required in OpenAPI	Optional. The maximum number of spaces to return.
`pageToken` query	string Not marked required in OpenAPI	Optional. A token from a previous ListSpaces response.

Request body

No request body is declared.

Responses

200 · OK

application/json · ListSpacesResponse

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition

{
  "tags": [
    "SpaceService"
  ],
  "description": "ListSpaces lists spaces of which the authenticated caller is a member.",
  "operationId": "SpaceService_ListSpaces",
  "parameters": [
    {
      "name": "pageSize",
      "in": "query",
      "description": "Optional. The maximum number of spaces to return.",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "name": "pageToken",
      "in": "query",
      "description": "Optional. A token from a previous ListSpaces response.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListSpacesResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}