DocumentationAPI reference

Rust · 0.1.0

List Space Invitations

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

SpaceService · SpaceService_ListSpaceInvitations

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 the space ADMIN role as an active member. An instance administrator who is not a space administrator cannot use these governance operations.

Request

ListSpaceInvitations lists the pending invitations for a space.

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

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 invitations to return.
pageToken
query
string
Not marked required in OpenAPI
Optional. A token from a previous ListSpaceInvitations response.

Request body

No request body is declared.

Responses

200 · OK

application/json · ListSpaceInvitationsResponse

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