DocumentationAPI reference

Rust · 0.1.0

List Space Members

GET /api/v1/spaces/{space}/members

SpaceService · SpaceService_ListSpaceMembers

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

ListSpaceMembers lists the members of a space.

GET/api/v1/spaces/{space}/members

Parameters

Name / locationType / requirementDescription
space
path
string
Required
The space id.
pageSize
query
integer (int32)
Not marked required in OpenAPI
Optional. The maximum number of members to return.
pageToken
query
string
Not marked required in OpenAPI
Optional. A token from a previous ListSpaceMembers response.

Request body

No request body is declared.

Responses

200 · OK

application/json · ListSpaceMembersResponse

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": "ListSpaceMembers lists the members of a space.",
  "operationId": "SpaceService_ListSpaceMembers",
  "parameters": [
    {
      "name": "space",
      "in": "path",
      "description": "The space id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "pageSize",
      "in": "query",
      "description": "Optional. The maximum number of members to return.",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "name": "pageToken",
      "in": "query",
      "description": "Optional. A token from a previous ListSpaceMembers response.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListSpaceMembersResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}