Skip to content
API Reference
Organization

Invites

List invites
GET/organization/invites
Create invite
POST/organization/invites
Retrieve invite
GET/organization/invites/{invite_id}
Delete invite
DELETE/organization/invites/{invite_id}
ModelsExpand Collapse
Invite = object { id, email, expires_at, 6 more }

Represents an individual invite to the organization.

id: string

The identifier, which can be referenced in API endpoints

email: string

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

expires_at: number

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

invited_at: number

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

object: "organization.invite"

The object type, which is always organization.invite

role: "owner" or "reader"

owner or reader

Accepts one of the following:
"owner"
"reader"
status: "accepted" or "expired" or "pending"

accepted,expired, or pending

Accepts one of the following:
"accepted"
"expired"
"pending"
accepted_at: optional number

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

projects: optional array of object { id, role }

The projects that were granted membership upon acceptance of the invite.

id: optional string

Project's public ID

role: optional "member" or "owner"

Project membership role

Accepts one of the following:
"member"
"owner"