Skip to main content
GET
/
api
/
v1
/
invitations
/
by-scope
/
{scopeType}
/
{scope}
Get Open Invitations by Scope
curl --request GET \
  --url https://api.example.com/api/v1/invitations/by-scope/{scopeType}/{scope}
{
  "invitations": [
    {
      "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

​
scope
string
required

The ID of the scope as defined in your system

​
scopeType
string
required

The type of the scope as defined in your system, such as "team" or "project". If your system does not have a scope type, use "default"

Query Parameters

​
start
number

Pagination start index. 20 invitations are returned at a time. The value here defaults to 0. If you want to retrieve the next 20, set this value to 19, 39, 59, etc.

Response

​
invitations
object[]
required

An array of invitations