DocumentationAPI reference

Rust · 0.1.0

List User Space Invitations

GET /api/v1/users/{user}/spaceInvitations

SpaceService · SpaceService_ListUserSpaceInvitations

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

Owner-only: the user named in the path must be the authenticated caller. Instance administrator status does not allow acting on another account here.

Request

ListUserSpaceInvitations lists the authenticated user's pending space invitations.

GET/api/v1/users/{user}/spaceInvitations

Parameters

Name / locationType / requirementDescription
user
path
string
Required
The user 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 ListUserSpaceInvitations response.

Request body

No request body is declared.

Responses

200 · OK

application/json · ListUserSpaceInvitationsResponse

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": "ListUserSpaceInvitations lists the authenticated user's pending space invitations.",
  "operationId": "SpaceService_ListUserSpaceInvitations",
  "parameters": [
    {
      "name": "user",
      "in": "path",
      "description": "The user 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 ListUserSpaceInvitations response.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListUserSpaceInvitationsResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}