DUduda
Groups API

List groups

Returns a page of membership groups for the site.

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

Request

  • Base URL
    https://api.duda.co
  • URL
    https://api.duda.co/api/sites/multiscreen/{site_name}/membership/groups
  • 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)

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": [
    {
      "id": "90f33a1b-27bb-4020-9f7d-99d6026547f0",
      "name": "Premium site members",
      "pages": [
        "7b31a091a92049bba02315a3c718ecb1",
        "1a5bfd0df22641db96902fc3c8dfd4f8"
      ]
    }
  ]
}

Changes

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