List Invites

Path Parameters

organizationName

string

required

The name of the organization or user.

Response

200 - application/json

invites

object[]

invites.ID

integer

The unique ID for the invite.

invites.CreatedAt

string

The datetime the invite was created in ISO 8601 format. Example: 2023-01-01T00:00:00Z

invites.UpdatedAt

string

The datetime the invite was updated in ISO 8601 format. Example: 2023-01-01T00:00:00Z

invites.DeletedAt

string

The datetime the invite was deleted (or revoked) in ISO 8601 format. Example: 2023-01-01T00:00:00Z

invites.Role

enum<string>

The assigned role for the invited user.

Available options:

admin,

member

invites.Email

string

The email of the person invited.

invites.OrganizationID

integer

The ID of the organization the user was invited to.

invites.Token

string

The unique token used to verify the invite.

invites.Organization

object

invites.Organization.name

string

The organization name. Every user has a personal organization for their own account.

invites.Organization.slug

string

The organization slug. This will be your username for personal accounts.

invites.Organization.type

enum<string>

The type of account this organization is. Will always be personal or team.

Available options:

personal,

team

invites.Organization.overages

boolean

The name of the organization. Every user has a personal organization for their own account.

invites.Organization.blocked_reads

boolean

Returns the current status for blocked reads.

invites.Organization.blocked_writes

boolean

Returns the current status for blocked writes.

invites.Accepted

boolean

The current status of the invite.

API

Resources

List Invites

Path Parameters

Response