Sign in
SessionRecurrenceGroups

List SessionRecurrenceGroups

This endpoint lists all the SessionRecurrenceGroups.

get/shop/recurrence-groups

Query parameters

archivedboolean

Whether to include archived resources in the response. When true, archived resources are returned; when false or omitted, only non-archived resources are returned.

recurrence_end_afterstring date
Example:2025-11-10

Retrieve SessionRecurrenceGroups where the end date is after this value.

recurrence_end_beforestring date
Example:2025-11-10

Retrieve SessionRecurrenceGroups where the end date is before this value.

session_type_idstring[]

A comma separated list of SessionType ids.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

site_idstring

Filter results by the site they belong to

Response

The SessionRecurrenceGroups were successfully retrieved.

Example response

{
  "data": [
    {
      "capacity": 12,
      "id": "609bd745e4358066f7061d82",
      "name": "Mondays with Adrienne",
      "practitioner": {
        "id": "5dcb47800000000000000000",
        "name": "Jane Doe"
      },
      "recurrence_end": "2021-05-10",
      "recurrence_start": "2021-04-10",
      "room": {
        "id": "5dcb47800000000000000000"
      },
      "start_time": "16:00",
      "start_times": [
        {
          "value": "16:00"
        }
      ],
      "weekdays": [
        "monday"
      ]
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes