Skip to main content
GET
Return a single invite by ID

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

plan_id
integer<uint64>
required

The ID of the plan

id
integer<uint64>
required

The ID of the invite

network_id
required

The Network's unique integer ID, or subdomain Unique numeric network ID

Response

An invite object

Invites allow users and admins to invite new users to the network

recipient_email
string
required

The recipients email address

Example:

"claude@example.com"

recipient_first_name
string
required

The recipient's first name

Example:

"Claude"

recipient_last_name
string
required

The recipient's last name

Example:

"Monet"

id
integer<uint64>
required

The record's integer ID

Example:

"1234"

created_at
string<date-time>
required

The date and time the record was created

Example:

"2026-07-14T19:59:54+00:00"

updated_at
string<date-time>
required

The date and time the record was last modified

Example:

"2026-07-14T19:59:54+00:00"

sender_id
integer<uint64>
required

The ID of the user that created the invitation

user_id
integer<uint64>
deprecated

Deprecated: Use sender_id instead