DUduda
Members API

List members

Returns a page of members for the site, optionally filtered by email, group id, and status.

get/api/sites/multiscreen/{site_name}/membership/members

Request

  • Base URL
    https://api.duda.co
  • URL
    https://api.duda.co/api/sites/multiscreen/{site_name}/membership/members
  • Auth
    HTTP basic

Path parameters

site_namestring required

The site's unique name (its ID), returned when the site is created.

Query parameters

cursorstring

Cursor-based offset provided in previous page response

limitinteger

Page size (number of elements per page)

emailstring

Member email to filter by

group_idstring

Group id to filter by

statusstring[]

Response

OK

cursorstring nullable

Cursor provided in request

limitinteger

Paging limit evaluated for request

next_pagestring nullable

Cursor value for querying next page

site_namestring

Owning site

total_responsesinteger

Total number of entities in for given site

Example response

{
  "cursor": "eyJjdXJzb3IiOiJjdXJzb3IiLCAiY3JlYXRpb25faWQiOiIxNWY0YjNiNGUtNGIzYi00YjNiLTRiM2ItNGIzYi00YjNiNGU0YjNiNGUifQ==",
  "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"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.