Members Object

{
  "cursor": "eyJjdXJzb3IiOiJjdXJzb3IiLCAiY3JlYXRpb25faWQiOiIxNWY0YjNiNGUtNGIzYi00YjNiLTRiM2ItNGIzYi00YjNiNGU0YjNiNGUifQ==",
  "limit": 50,
  "next_page": "eyJjcmVhdGlvbl9pZCI6IjE1ZjRiM2I0ZS00YjNiLTRiM2ItNGIzYi00YjNiLTRiM2I0ZTRiM2I0ZSIsImN1cnNvciI6ImN1cnNvciJ9",
  "results": [
    {
      "email": "[email protected]",
      "first_name": "John",
      "groups": [
        {
          "id": "15f4b3b4e-4b3b-4b3b-4b3b-4b3b4e4b3b4e",
          "name": "Premium users"
        }
      ],
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "last_login": "2024-08-01T00:00:00Z",
      "last_name": "Doe",
      "registered": "2024-08-01T00:00:00Z",
      "status": "ACTIVE"
    }
  ],
  "site_name": "string",
  "total_responses": 1
}

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

email string

The member's email address.

first_name
string

The member's first name.

groups
object

See the section below for details .

id
string

The unique identifier of the member.

last_login
string

The member's last login ISO date-time.

last_name
string

The member's last name.

registered
string

The member's registered ISO date-time

status
string

The member's status:

  • *PENDING**: Site owner did not yet approve the member (for approval-based membership), the member will not have access to any protected site pages
  • *ACTIVE:** Membership is approved, the member has some access to protected site pages
  • *UNAUTHORIZED: **Indicates that members count limit was reached for the site, the member will not have access to any protected site pages

Groups Object

The membership groups that the member belongs to.

Field

Description

id string

The group id.

name
string

The name of the group.