List pending invitations for a space

3 parameters

spacestringrequired

The identifier of the space whose pending invitations to list.

pageSizeintegeroptional

The maximum number of invitations to return in the response.

pageTokenstringoptional

A pagination token from a previous ListSpaceInvitations response.

2 status codes

200Returns the pending invitations for the space and a `nextPageToken` when another page of results 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 space path parameter must identify the space whose invitations you want to list. To continue pagination, pageToken must come from a previous ListSpaceInvitations response.

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

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

const result = await client.invitations.list({
  space: "example",
  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