curl --request GET \
--url https://api.example.com/api/v1/invitations \
--header 'x-api-key: <api-key>'{
"invitations": [
{
"id": "invitation-12345",
"accountId": "account-12345",
"attributes": {},
"clickThroughs": 5,
"configurationAttributes": {},
"createdAt": "2023-10-01T12:00:00Z",
"deactivated": false,
"deliveryCount": 3,
"deliveryTypes": [
"email",
"phone"
],
"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",
"deploymentId": "deployment-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,
"source": "email",
"expires": "2023-11-01T12:00:00Z",
"metadata": {
"customerId": "12345",
"source": "web"
},
"passThrough": "eyJhbGciOiJBMjU2R0NNIiwiZW5jIjoiQTI1NkdDTSJ9..."
}
]
}This endpoint retrieves open invitations for a specific invitee, as identified by target type and value, and should be used to find open invitations for registered users. This can be used as part of providing an in-product invitation acceptance flow. For email targets, this will also include autojoin invitations for the email domain.
curl --request GET \
--url https://api.example.com/api/v1/invitations \
--header 'x-api-key: <api-key>'{
"invitations": [
{
"id": "invitation-12345",
"accountId": "account-12345",
"attributes": {},
"clickThroughs": 5,
"configurationAttributes": {},
"createdAt": "2023-10-01T12:00:00Z",
"deactivated": false,
"deliveryCount": 3,
"deliveryTypes": [
"email",
"phone"
],
"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",
"deploymentId": "deployment-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,
"source": "email",
"expires": "2023-11-01T12:00:00Z",
"metadata": {
"customerId": "12345",
"source": "web"
},
"passThrough": "eyJhbGciOiJBMjU2R0NNIiwiZW5jIjoiQTI1NkdDTSJ9..."
}
]
}The means by which the invitee will be identified, with email currently the only supported type
email, phone, share, internal An array of invitations
Show child attributes