Membership Invitation Object

{
  "cursor": "eyJjdXJzb3IiOiJjdXJzb3IiLCAiY3JlYXRpb25faWQiOiIxNWY0YjNiNGUtNGIzYi00YjNiLTRiM2ItNGIzYi00YjNiNGU0YjNiNGUifQ==",
  "limit": 50,
  "next_page": "eyJjcmVhdGlvbl9pZCI6IjE1ZjRiM2I0ZS00YjNiLTRiM2ItNGIzYi00YjNiLTRiM2I0ZTRiM2I0ZSIsImN1cnNvciI6ImN1cnNvciJ9",
  "results": [
    {
      "created": "2024-08-01T00:00:00Z",
      "email": "[email protected]",
      "groups": [
        {
          "id": "15f4b3b4e-4b3b-4b3b-4b3b-4b3b4e4b3b4e",
          "name": "Premium users"
        }
      ],
      "id": "5f4b3b4e-4b3b-4b3b-4b3b-4b3b4e4b3b4e"
    }
  ],
  "site_name": "string",
  "total_responses": 0
}

Field

Description

cursor string

Cursor-based offset provided in previous page response.

limit
number

Page size (number of elements per page). Default value: 50

next_page
string

Cursor-based offset for next page of data.

results
object

See the section below for details.

site_name
string

The unique identifier of the target site.

total_responses
number

Total number of entities in for given site.

Results Object

Field

Description

created string

Invitation creation ISO date-time.

email
string

Email address associated with the invitation.

groups
object

See the section below for details .

id
string

The unique identifier of the invitation.

Groups Object

The membership groups that the member belongs to.

Field

Description

id string

The group id.

name
string

The name of the group.