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

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, member, admin, potential-member, stack-collaborator, billing-manager
    • ↳ 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.