List a user's pending space invitations

3 parameters

userstringrequired

The user ID whose pending space invitations you want to list.

pageSizeintegeroptional

Maximum number of invitations to return. No default is specified.

pageTokenstringoptional

Token from a previous response to retrieve the next page. Omit it to retrieve the first page.

2 status codes

200Returns a list of pending space invitations and a `nextPageToken` when another page is available.

spaceInvitationsarray<object>optional

nextPageTokenstringoptional

defaultDefault error response

codeintegeroptional

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestringoptional

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsarray<object>optional

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Error handling

The user path parameter must identify the user whose pending invitations you want to list. Use the nextPageToken from a response as pageToken to retrieve a subsequent page.

import { Client } from "memos-unofficial-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.spaceInvitations.list({
  user: "octocat",
  pageSize: 20,
  pageToken: "sk_live_4eC39Hq",
});

{
  "spaceInvitations": [
    {
      "name": "Example Name",
      "invitee": "example_value",
      "role": "ROLE_UNSPECIFIED",
      "space": {
        "name": "Example Name",
        "title": "Example Title",
        "description": "Example description",
        "currentUserRole": "ROLE_UNSPECIFIED",
        "memberCount": 42,
        "icon": {
          "emoji": null,
          "lucide": null
        }
      }
    }
  ],
  "nextPageToken": 1
}

Request

Response

Errors