curl --request GET \
--url https://api.example.com/api/v1/invitations/by-scope/{scopeType}/{scope}/autojoin \
--header 'x-api-key: <api-key>'{
"autojoinDomains": [
{
"id": "<string>",
"domain": "<string>"
}
],
"invitation": {
"id": "invitation-12345",
"accountId": "account-12345",
"attributes": {},
"clickThroughs": 5,
"configurationAttributes": {},
"formSubmissionData": {
"email": {
"type": "email",
"value": "invitee@example.com"
},
"personalMessage": {
"type": "text",
"value": "Join me on AcmeTasks!"
},
"role": {
"type": "select",
"value": "admin"
}
},
"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": "foo@bar.com"
}
],
"views": 10,
"widgetConfigurationId": "widget-12345",
"widgetId": "widget-uuid",
"deploymentId": "deployment-12345",
"scope": "6b366c56-c0a9-4689-b763-20c890481bc8",
"scopeType": "project",
"expired": false,
"source": "email",
"subtype": "pymk",
"expires": "2023-11-01T12:00:00Z",
"metadata": {
"customerId": "12345",
"source": "web"
},
"passThrough": "eyJhbGciOiJBMjU2R0NNIiwiZW5jIjoiQTI1NkdDTSJ9..."
}
}This endpoint retrieves the list of domains configured for autojoin for a specific scope, and is typically used to provide an interface for your customers’ admins to manage autojoin settings (i.e., adding and removing domains, independent of the invite form).
curl --request GET \
--url https://api.example.com/api/v1/invitations/by-scope/{scopeType}/{scope}/autojoin \
--header 'x-api-key: <api-key>'{
"autojoinDomains": [
{
"id": "<string>",
"domain": "<string>"
}
],
"invitation": {
"id": "invitation-12345",
"accountId": "account-12345",
"attributes": {},
"clickThroughs": 5,
"configurationAttributes": {},
"formSubmissionData": {
"email": {
"type": "email",
"value": "invitee@example.com"
},
"personalMessage": {
"type": "text",
"value": "Join me on AcmeTasks!"
},
"role": {
"type": "select",
"value": "admin"
}
},
"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": "foo@bar.com"
}
],
"views": 10,
"widgetConfigurationId": "widget-12345",
"widgetId": "widget-uuid",
"deploymentId": "deployment-12345",
"scope": "6b366c56-c0a9-4689-b763-20c890481bc8",
"scopeType": "project",
"expired": false,
"source": "email",
"subtype": "pymk",
"expires": "2023-11-01T12:00:00Z",
"metadata": {
"customerId": "12345",
"source": "web"
},
"passThrough": "eyJhbGciOiJBMjU2R0NNIiwiZW5jIjoiQTI1NkdDTSJ9..."
}
}The name of the entity that the ID passed in scope refers to (e.g., “workspace”, “organization”, “team”). Ensures that you don’t have any issues disambiguating the ID in cases where there are multiple types of entities to which someone can be invited. If your system does not have a scope type, use "default".
The ID in your system of the entity to which autojoin applies (e.g., workspace, team, org).