v1
latestOpenAPI 3.1.02026-07-242470655.6 KBGet Members
get/sites/multiscreen/{site_name}/membership/members
Path parameters
site_namestring required
The unique identifier of the target site.
Query parameters
emailstring
Member email to filter by.
group_idstring
Member Group id to filter by
statusstring[]
Status of Member to filter by. ACTIVE, PENDING, UNAUTHORIZED
cursorstring
Cursor-based offset provided in previous page response. Can be used to collect next page of data
limitstring
Page size (number of elements per page). Default is 50.
Response
200
Example response
{
"cursor": "eyJjdXJzb3IiOiJjdXJzb3IiLCAiY3JlYXRpb25faWQiOiIxNWY0YjNiNGUtNGIzYi00YjNiLTRiM2ItNGIzYi00YjNiNGU0YjNiNGUifQ==",
"limit": 50,
"next_page": "eyJjcmVhdGlvbl9pZCI6IjE1ZjRiM2I0ZS00YjNiLTRiM2ItNGIzYi00YjNiLTRiM2I0ZTRiM2I0ZSIsImN1cnNvciI6ImN1cnNvciJ9",
"results": [
{
"email": "john.doe@example.com",
"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"
}