Skip to main content

List invites

GET https://api.rollstack.com/public/v1/invites

The pending invites of the organization, with the role and authentication role each user joins with, and when they were invited.

Requires the users:read scope. Only owners and admins of the organization may call it.

Operation ID: listInvites. Only owners and admins can call it.

Response 200

Success

application/json: array of object

  • id (string, required): Unique identifier for the invite. Pass it as inviteId to deleteInvite to cancel the invite.
  • email (string, required): The email address invited to join the organization.
  • role (string, required): The role the person gets when they accept the invite. owner can do everything in the organization, admin manages its settings, members and invites, and member uses Rollstack without managing the organization. One of owner, admin, member.
  • authenticationRole (string or null, required): The access to the organization's Authentication settings (Single Sign-On and SCIM provisioning) the person gets when they accept the invite: viewer can see them, editor can also change them, and null gives none. One of viewer, editor.
  • createdAt (string (date-time), required): When the person was invited.