Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Admin
Organization

Invites

List invites
InviteListPage admin().organization().invites().list(InviteListParamsparams = InviteListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/invites
Create invite
Invite admin().organization().invites().create(InviteCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/invites
Retrieve invite
Invite admin().organization().invites().retrieve(InviteRetrieveParamsparams = InviteRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/invites/{invite_id}
Delete invite
InviteDeleteResponse admin().organization().invites().delete(InviteDeleteParamsparams = InviteDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/invites/{invite_id}
ModelsExpand Collapse
class Invite:

Represents an individual invite to the organization.

String id

The identifier, which can be referenced in API endpoints

long createdAt

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

formatunixtime
String email

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

JsonValue; object_ "organization.invite"constant"organization.invite"constant

The object type, which is always organization.invite

List<Project> projects

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

String id

Project’s public ID

Role role

Project membership role

One of the following:
MEMBER("member")
OWNER("owner")
Role role

owner or reader

One of the following:
OWNER("owner")
READER("reader")
Status status

accepted,expired, or pending

One of the following:
ACCEPTED("accepted")
EXPIRED("expired")
PENDING("pending")
Optional<Long> acceptedAt

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

formatunixtime
Optional<Long> expiresAt

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

formatunixtime