Skip to content

Retrieves an invite.

GET
/organization/invites/{invite_id}

Authorizations

Parameters

Path Parameters

invite_id
required
string

The ID of the invite to retrieve.

Responses

200

Invite retrieved successfully.

Represents an individual invite to the organization.

object
object
required

The object type, which is always organization.invite

string
Allowed values: organization.invite
id
required

The identifier, which can be referenced in API endpoints

string
email
required

The email address of the individual to whom the invite was sent

string
role
required

owner or reader

string
Allowed values: owner reader
status
required

accepted,expired, or pending

string
Allowed values: accepted expired pending
invited_at
required

The Unix timestamp (in seconds) of when the invite was sent.

integer
expires_at
required

The Unix timestamp (in seconds) of when the invite expires.

integer
accepted_at

The Unix timestamp (in seconds) of when the invite was accepted.

integer