Skip to main content
GET
/
api
/
v1
/
invitations
/
by-scope
/
{scopeType}
/
{scope}
/
autojoin
Get autojoin domains for a specific scope
curl --request GET \
  --url https://api.example.com/api/v1/invitations/by-scope/{scopeType}/{scope}/autojoin
{
  "autojoinDomains": [
    {
      "id": "<string>",
      "domain": "<string>"
    }
  ],
  "invitation": {
    "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

scopeType
string
required

The type of scope

scope
string
required

The scope identifier

Response

Successfully retrieved autojoin domains

autojoinDomains
object[]
required

List of autojoin domain configurations

invitation
object
required

Invitation entry associated with autojoin for this scope