Calendar & Scheduling

Session Recurrence Groups

A SessionRecurrenceGroup represents the recurrence of sessions for a SessionType.

The SessionRecurrenceGroup object

Attributes

capacityintegerrequired
The capacity of each session in this group.
deleted_atdate-timerequirednullable
A timestamp of when the this was deleted.
idobject-idrequired
The ID of the recurrence group.
namestringrequired
An option name for the recurrence group.
practitioneroptional
The practitioner who leads the sessions in this group.
recurrence_enddaterequirednullable
The end date of the recurrence group.
recurrence_startdaterequirednullable
The start date of the recurrence group.
roomrequired
The room where the sessions in this group take place.
session_type_idobject-idrequired
The ID of the SessionType this SessionRecurrenceGroup belongs to.
start_timestringrequirednullableDeprecated
The start time of each occurrence, in 24 hour format
start_timesobject[]required
An array of start times
weekdaysstring[]required
The weekdays this rule applies to

{
  "capacity": 12,
  "deleted_at": "2026-01-15T09:30:00+00:00",
  "id": "609bd745e4358066f7061d82",
  "name": "Mondays with Adrienne",
  "practitioner": "string",
  "recurrence_end": "2021-05-10",
  "recurrence_start": "2021-04-10",
  "room": "string",
  "session_type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "start_time": "16:00",
  "start_times": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "value": "16:00"
    }
  ],
  "weekdays": [
    "monday"
  ]
}

get/shop/recurrence-groups

List SessionRecurrenceGroups

listSessionRecurrenceGroups

This endpoint lists all the SessionRecurrenceGroups.

Query parameters

archivedbooleanoptional
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_afterdateoptional
Retrieve SessionRecurrenceGroups where the end date is after this value.
recurrence_end_beforedateoptional
Retrieve SessionRecurrenceGroups where the end date is before this value.
session_type_idstring[]optional
A comma separated list of SessionType ids.
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page
site_idstringoptional
Filter results by the site they belong to

Responses

200
The SessionRecurrenceGroups were successfully retrieved.
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/recurrence-groups" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/recurrence-groups', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/recurrence-groups",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/recurrence-groups', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/recurrence-groups", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The `SessionRecurrenceGroup`s were successfully retrieved.

{
  "data": [
    {
      "capacity": 12,
      "deleted_at": "2026-01-15T09:30:00+00:00",
      "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",
        "capacity": 1,
        "name": "Alex Morgan"
      },
      "session_type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "start_time": "16:00",
      "start_times": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "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"
  }
}

{
  "message": "Unauthenticated"
}

post/shop/recurrence-groups

Create a new SessionRecurrenceGroup

createSessionRecurrenceGroup

This endpoint creates a new SessionRecurrenceGroup for a SessionType.

Request body

namestringoptional
An option name for the recurrence group.
practitioner_idobject-idoptional
The practitioner who leads the sessions in this group.
room_idobject-idoptional
The room where the sessions in this group take place.
weekdaysstring[]optional
The weekdays sessions in this group take place.
start_timestringoptional
The start time of each occurrence in this group, in 24 hour format.
start_timesobject[]optional
capacityintegeroptional
The capacity of each session in this group.
recurrence_startdateoptionalnullable
The start date of the recurrence group.
recurrence_enddateoptionalnullable
The end date of the recurrence group.
session_type_idobject-idrequired
The SessionType that this SessionRecurrenceGroup belongs to.

Responses

201
The recurrence group was successfully created.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/recurrence-groups" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Mondays with Adrienne",
  "practitioner_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "room_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "weekdays": [
    "monday"
  ],
  "start_time": "16:00",
  "start_times": [
    {
      "value": "12:00"
    }
  ],
  "capacity": 12,
  "recurrence_start": "2021-04-10",
  "recurrence_end": "2021-05-10",
  "session_type_id": "64a9f3b2c3d8e1f4a5b6c7d8"
}'

const response = await fetch('https://api.playground.try.be/shop/recurrence-groups', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Mondays with Adrienne",
    "practitioner_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "room_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "weekdays": [
      "monday"
    ],
    "start_time": "16:00",
    "start_times": [
      {
        "value": "12:00"
      }
    ],
    "capacity": 12,
    "recurrence_start": "2021-04-10",
    "recurrence_end": "2021-05-10",
    "session_type_id": "64a9f3b2c3d8e1f4a5b6c7d8"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/recurrence-groups",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Mondays with Adrienne",
        "practitioner_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "room_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "weekdays": [
            "monday"
        ],
        "start_time": "16:00",
        "start_times": [
            {
                "value": "12:00"
            }
        ],
        "capacity": 12,
        "recurrence_start": "2021-04-10",
        "recurrence_end": "2021-05-10",
        "session_type_id": "64a9f3b2c3d8e1f4a5b6c7d8"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/recurrence-groups', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Mondays with Adrienne',
            'practitioner_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
            'room_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
            'weekdays' => [
                'monday'
            ],
            'start_time' => '16:00',
            'start_times' => [
                [
                    'value' => '12:00'
                ]
            ],
            'capacity' => 12,
            'recurrence_start' => '2021-04-10',
            'recurrence_end' => '2021-05-10',
            'session_type_id' => '64a9f3b2c3d8e1f4a5b6c7d8'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Mondays with Adrienne",
		"practitioner_id": "64a9f3b2c3d8e1f4a5b6c7d8",
		"room_id": "64a9f3b2c3d8e1f4a5b6c7d8",
		"weekdays": []interface{}{
			"monday",
		},
		"start_time": "16:00",
		"start_times": []interface{}{
			map[string]interface{}{
				"value": "12:00",
			},
		},
		"capacity": 12,
		"recurrence_start": "2021-04-10",
		"recurrence_end": "2021-05-10",
		"session_type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/recurrence-groups", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The recurrence group was successfully created.

{
  "data": {
    "capacity": 12,
    "deleted_at": "2026-01-15T09:30:00+00:00",
    "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",
      "capacity": 1,
      "name": "Alex Morgan"
    },
    "session_type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "start_time": "16:00",
    "start_times": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "value": "16:00"
      }
    ],
    "weekdays": [
      "monday"
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

put/shop/recurrence-groups/{recurrenceGroupId}

Update a SessionRecurrenceGroup

updateSessionRecurrenceGroup

This endpoint updates a SessionRecurrenceGroup.

Path parameters

recurrenceGroupIdobject-idrequired
Identifier of the session recurrence group. Recurrence groups represent a series of recurring class or session instances; this ID lets you update the series (e.g. cancel future occurrences, change capacity) or delete it outright.

Request body

namestringoptional
An option name for the recurrence group.
practitioner_idstringoptional
The practitioner who leads the sessions in this group.
room_idstringoptional
The room where the sessions in this group take place.
weekdaysstring[]optional
The weekdays sessions in this group take place.
start_timestringoptional
The start time of each occurrence in this group, in 24 hour format.
start_timesobject[]optional
capacityintegeroptional
The capacity of each session in this group.
recurrence_startdateoptionalnullable
The start date of the recurrence group.
recurrence_enddateoptionalnullable
The end date of the recurrence group.

Responses

200
The recurrence group was successfully updated.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/recurrence-groups/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Mondays with Adrienne",
  "practitioner_id": "5f184bb0b6ecff2e8157bf27",
  "room_id": "5dcb47800000000000000010",
  "weekdays": [
    "monday"
  ],
  "start_time": "16:00",
  "start_times": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "value": "12:00"
    }
  ],
  "capacity": 12,
  "recurrence_start": "2021-04-10",
  "recurrence_end": "2021-05-10"
}'

const response = await fetch('https://api.playground.try.be/shop/recurrence-groups/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Mondays with Adrienne",
    "practitioner_id": "5f184bb0b6ecff2e8157bf27",
    "room_id": "5dcb47800000000000000010",
    "weekdays": [
      "monday"
    ],
    "start_time": "16:00",
    "start_times": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "value": "12:00"
      }
    ],
    "capacity": 12,
    "recurrence_start": "2021-04-10",
    "recurrence_end": "2021-05-10"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/recurrence-groups/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Mondays with Adrienne",
        "practitioner_id": "5f184bb0b6ecff2e8157bf27",
        "room_id": "5dcb47800000000000000010",
        "weekdays": [
            "monday"
        ],
        "start_time": "16:00",
        "start_times": [
            {
                "id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "value": "12:00"
            }
        ],
        "capacity": 12,
        "recurrence_start": "2021-04-10",
        "recurrence_end": "2021-05-10"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/recurrence-groups/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Mondays with Adrienne',
            'practitioner_id' => '5f184bb0b6ecff2e8157bf27',
            'room_id' => '5dcb47800000000000000010',
            'weekdays' => [
                'monday'
            ],
            'start_time' => '16:00',
            'start_times' => [
                [
                    'id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'value' => '12:00'
                ]
            ],
            'capacity' => 12,
            'recurrence_start' => '2021-04-10',
            'recurrence_end' => '2021-05-10'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Mondays with Adrienne",
		"practitioner_id": "5f184bb0b6ecff2e8157bf27",
		"room_id": "5dcb47800000000000000010",
		"weekdays": []interface{}{
			"monday",
		},
		"start_time": "16:00",
		"start_times": []interface{}{
			map[string]interface{}{
				"id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"value": "12:00",
			},
		},
		"capacity": 12,
		"recurrence_start": "2021-04-10",
		"recurrence_end": "2021-05-10",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/recurrence-groups/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The recurrence group was successfully updated.

{
  "data": {
    "capacity": 12,
    "deleted_at": "2026-01-15T09:30:00+00:00",
    "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",
      "capacity": 1,
      "name": "Alex Morgan"
    },
    "session_type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "start_time": "16:00",
    "start_times": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "value": "16:00"
      }
    ],
    "weekdays": [
      "monday"
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/recurrence-groups/{recurrenceGroupId}

Archive a SessionRecurrenceGroup

deleteSessionRecurrenceGroup

This endpoint archives a SessionRecurrenceGroup.

Path parameters

recurrenceGroupIdobject-idrequired
Identifier of the session recurrence group. Recurrence groups represent a series of recurring class or session instances; this ID lets you update the series (e.g. cancel future occurrences, change capacity) or delete it outright.

Responses

204
The SessionRecurrenceGroup was successfully deleted.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/recurrence-groups/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/recurrence-groups/abc123', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/shop/recurrence-groups/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/shop/recurrence-groups/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/shop/recurrence-groups/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The `SessionRecurrenceGroup` was successfully deleted.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}