Skip to main content
GET
/
api
/
v1
/
invitations
/
{invitationId}
Get invitation
curl --request GET \
  --url https://api.example.com/api/v1/invitations/{invitationId}
{
  "id": "invitation-12345",
  "accountId": "account-12345",
  "attributes": {},
  "clickThroughs": 5,
  "configurationAttributes": {},
  "createdAt": "2023-10-01T12:00:00Z",
  "deactivated": false,
  "deliveryCount": 3,
  "deliveryTypes": [
    "email",
    "sms"
  ],
  "foreignCreatorId": "creator-12345",
  "invitationType": "single_use",
  "modifiedAt": "2023-10-01T12:00:00Z",
  "status": "queued",
  "target": [
    {
      "type": "email",
      "value": "[email protected]"
    }
  ],
  "views": 10,
  "widgetConfigurationId": "widget-12345",
  "projectId": "project-67890",
  "groups": [
    {
      "type": "workspace",
      "id": "workspace-12345",
      "name": "Development Team"
    }
  ],
  "accepts": [
    {
      "id": "accept-12345",
      "status": "accepted"
    }
  ],
  "scope": "6b366c56-c0a9-4689-b763-20c890481bc8",
  "scopeType": "project",
  "expired": false,
  "expires": "2023-11-01T12:00:00Z"
}

Path Parameters

​
invitationId
string
required

The ID of the invitation

Response

​
id
string
required

The ID of the invitation

Example:

"invitation-12345"

​
accountId
string
required

The ID of the account associated with the invitation

Example:

"account-12345"

​
attributes
object
required

Various attributes of the invitation, none exist at the moment, but this acts as a placeholder for future use

​
clickThroughs
number
required

The number of times the invitation has been clicked

Example:

5

​
configurationAttributes
object
required

The configuration attributes for the invitation. Includes raw data from widgets.

Example:
{}
​
createdAt
string<date-time>
required

The date and time when the invitation was created

Example:

"2023-10-01T12:00:00Z"

​
deactivated
boolean
required

Indicates whether the invitation has been deactivated

Example:

false

​
deliveryCount
number
required

The number of times the invitation has been delivered

Example:

3

​
deliveryTypes
string[]
required

The types of delivery methods used for the invitation

Example:
["email", "sms"]
​
foreignCreatorId
string
required

The ID of the creator in your system associated with the invitation

Example:

"creator-12345"

​
invitationType
enum<string>
required

The type of the invitation

Available options:
single_use,
multi_use
Example:

"single_use"

​
modifiedAt
string<date-time>
required

The date and time when the invitation was last modified

Example:

"2023-10-01T12:00:00Z"

​
status
enum<string>
required

The current status of the invitation

Available options:
queued,
sending,
delivered,
accepted,
shared,
unfurled,
accepted_elsewhere
Example:

"queued"

​
target
object[]
required

The target(s) for the invitation, such as email or phone

Example:
[{ "type": "email", "value": "[email protected]" }]
​
views
number
required

The number of times the invitation has been viewed

Example:

10

​
widgetConfigurationId
string
required

The ID of the widget configuration associated with the invitation

Example:

"widget-12345"

​
projectId
string
required

The ID of the project associated with the invitation

Example:

"project-67890"

​
groups
object[]
required

DEPRECATED: The groups associated with the invitation, such as workspaces or teams

Example:
[
  {
    "type": "workspace",
    "id": "workspace-12345",
    "name": "Development Team"
  }
]
​
accepts
object[]
required

The acceptance details for the invitation

Example:
[
  {
    "id": "accept-12345",
    "status": "accepted"
  }
]
​
scope
string
required

The scope of the invitation

Example:

"6b366c56-c0a9-4689-b763-20c890481bc8"

​
scopeType
string
required

The type of scope for the invitation

Example:

"project"

​
expired
boolean
required

Indicates whether the invitation has expired based on the expiry configuration. Always false if the invitation has no expiry configured.

Example:

false

​
expires
string<date-time>

The date and time when the invitation will expire or has expired. Only present if the invitation has an expiry configuration (expiryDays > 0).

Example:

"2023-11-01T12:00:00Z"