Skip to main content
GET
/
api
/
v1
/
invitations
/
by-group
/
{groupType}
/
{groupId}
{
  "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": "foo@bar.com"
        }
      ],
      "views": 10,
      "widgetConfigurationId": "widget-12345",
      "projectId": "project-67890",
      "groups": [
        {
          "type": "workspace",
          "id": "workspace-12345",
          "name": "Development Team"
        }
      ],
      "accepts": [
        {
          "id": "accept-12345",
          "status": "accepted"
        }
      ]
    }
  ]
}

Path Parameters

groupId
string
required

The ID of the group as defined in your system

groupType
string
required

The type of the group as defined in your system, such as "team" or "project"

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