Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

Invitations API

6 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

invitations.candidates

List people in the directory who can be invited to the workspace

POST/api/v1/manage/invitations/candidates

const result = await shuffl.invitations.candidates({});
Request fields (1)
  • search string optional
Response object[]
  • email string required
  • id string required
  • name string required

invitations.list

List pending workspace invitations

POST/api/v1/manage/invitations/list

const result = await shuffl.invitations.list();
Request fields (none)

This operation takes no input.

Response object[]
  • createdAt string (date-time) required
  • email string required
  • expiresAt string (date-time) required
  • id string required
  • inviterId string required
  • organizationId string required
  • role "admin" | "member" | "owner" required
  • status "accepted" | "canceled" | "pending" | "rejected" required
  • teamId string required
  • teamRole "admin" | "member" | "owner" required

invitations.cancel

Cancel a pending workspace invitation

POST/api/v1/manage/invitations/cancel

const result = await shuffl.invitations.cancel({
  "id": "<id>",
  "requestKey": "a-new-unique-key"
});
Request fields (2)
  • id string required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • createdAt string (date-time) required
    • email string required
    • expiresAt string (date-time) required
    • id string required
    • inviterId string required
    • organizationId string required
    • role "admin" | "member" | "owner" required
    • status "accepted" | "canceled" | "pending" | "rejected" required
    • teamId string required
    • teamRole "admin" | "member" | "owner" required

invitations.create

Invite this person with the selected team role

POST/api/v1/manage/invitations/create

  • Write
  • Permission invitations.create
  • Needs a requestKey
  • Needs confirm set to invitations.create
const result = await shuffl.invitations.create({
  "email": "<email>",
  "role": "admin",
  "confirm": "invitations.create",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • email string required
  • role "admin" | "member" required
  • confirm "invitations.create" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • createdAt string (date-time) required
    • email string required
    • expiresAt string (date-time) required
    • id string required
    • inviterId string required
    • organizationId string required
    • role "admin" | "member" | "owner" required
    • status "accepted" | "canceled" | "pending" | "rejected" required
    • teamId string required
    • teamRole "admin" | "member" | "owner" required

invitations.createMany

Invite these people with the selected team role

POST/api/v1/manage/invitations/createMany

const result = await shuffl.invitations.createMany({
  "emails": [
    "<emails>"
  ],
  "role": "admin",
  "confirm": "invitations.createMany",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • emails string[] required
  • role "admin" | "member" required
  • confirm "invitations.createMany" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • alreadyInvited number required
    • alreadyMember number required
    • invited object[] required
      • createdAt string (date-time) required
      • email string required
      • expiresAt string (date-time) required
      • id string required
      • inviterId string required
      • organizationId string required
      • role "admin" | "member" | "owner" required
      • status "accepted" | "canceled" | "pending" | "rejected" required
      • teamId string required
      • teamRole "admin" | "member" | "owner" required
    • unsent number required

invitations.inviteDirectory

Invite everyone in the directory who is not invited yet

POST/api/v1/manage/invitations/inviteDirectory

const result = await shuffl.invitations.inviteDirectory({
  "confirm": "invitations.inviteDirectory",
  "requestKey": "a-new-unique-key"
});
Request fields (2)
  • confirm "invitations.inviteDirectory" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • alreadyInvited number required
    • alreadyMember number required
    • invited object[] required
      • createdAt string (date-time) required
      • email string required
      • expiresAt string (date-time) required
      • id string required
      • inviterId string required
      • organizationId string required
      • role "admin" | "member" | "owner" required
      • status "accepted" | "canceled" | "pending" | "rejected" required
      • teamId string required
      • teamRole "admin" | "member" | "owner" required
    • remaining number required
    • unsent number required