1. Docs
2. Reference
3. REST API Docs
4. Schema
5. ListOrganizationInvitesResponse

ListOrganizationInvitesResponse describes all pending invites for an organization.

Properties

• invites array[PendingOrganizationInvite] required
  The list of pending organization invites
• ↳ id string required
  ID is the internal ID of the invite. Used to refer to this invite later to accept/cancel.
• ↳ email string required
  The email address the invite was sent to.
• ↳ role enum required
  Role is the new role to give the member. Must be one of MEMBER, ADMIN, or BILLING MANAGER.
  Values:

  none — None

  OrganizationRoleNone describes the role of non-members.

  member — Member

  OrganizationRoleMember is the role for regular members.

  admin — Admin

  OrganizationRoleAdmin is the role for admins.

  potential-member — PotentialMember

  OrganizationRolePotentialMember is the role for users who are explicitly not a member of the organization, but are a member of the backing org on the 3rd party identity provider. (i.e. they could join the org.)

  stack-collaborator — StackCollaborator

  OrganizationRoleStackCollaborator is the role for users who are not a member of an organization, but have been explicitly granted access to some of the organization’s stacks. So they have limited permissions to access the org’s data.

  billing-manager — BillingManager

  OrganizationRoleBillingManager is the role for billing admins.

• ↳ sentBy UserInfo required
  The user who sent the invite.
• ↳ sentAt integer required
  SentAt is the timestamp when the invite was first sent.
• ↳ acceptInviteUrl string required
  AcceptInviteURL is the url where a user would go to accept an invite to an organization.
• ↳ acceptError string optional
  AcceptError is the most recent error a user has hit while trying to accept an organization invite. By default it is null.
• ↳ status string required
  The friendly name of the invite status. Valid values are “pending”, “accepted”, “expired”, and “canceled”.
• ↳ roleId string optional
  RoleID is the optional UUID of a custom role assigned to this invite.