Group classes API

A weekly class timetable with places, instructors, bookings and attendance.

Module code group_classes · 12 actions · 4 data models · 11 events. A key or token never does more here than the person behind it can; row-level security applies exactly as in the app. Scopes: group_classes (everything), group_classes:read (read only) or group_classes:<capability>.

Resources

Lists take limit (up to 200), cursor, order (e.g. -created_at), fields and q; every other query parameter is a column filter: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

Actions

group_classes.add_schedule

Add a weekly time — Starts a new series: the class runs every week at this day and time.

Needs group_classes:manage · changes data

• Canonical address: POST /api/v1/actions/group_classes.add_schedule

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: group_classes.series_created

What it writes: group_class_schedule (insert) — Writes the series

curl -X POST https://app.getera.io/api/v1/group_class_schedules/actions/add_schedule \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"groupClassId":"GROUP_CLASS_ID","weekday":1,"startTime":"Starts","duration":1}'

{
  "ok": true,
  "result": "…",
  "events": [
    "group_classes.series_created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.groupClassSchedules.addSchedule({
  groupClassId: "GROUP_CLASS_ID",
  weekday: 1,
  startTime: "Starts",
  duration: 1
})

era group_class_schedules add_schedule \
  --group-class-id "GROUP_CLASS_ID" \
  --weekday 1 \
  --start-time "Starts" \
  --duration 1

{
  "name": "era__group_classes__add_schedule",
  "arguments": {
    "groupClassId": "GROUP_CLASS_ID",
    "weekday": 1,
    "startTime": "Starts",
    "duration": 1
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold group_classes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_found, class_archived, no_schedule, schedule_exists, service_not_offered_that_day, provider_cannot_perform · 429 slow down

group_classes.archive_class

Retire a class — Stops taking bookings. The history stays.

Needs group_classes:manage · reaches outside (sends, publishes or charges) · asks a person to confirm when Era runs it

• Canonical address: POST /api/v1/actions/group_classes.archive_class

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: group_classes.class_archived

What it writes: group_class (update) — Stamps archived_at; group_class_schedule (update) — Ends every running series today

curl -X POST https://app.getera.io/api/v1/group_classes/GROUP_CLASSE_ID/actions/archive_class \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "group_classes.class_archived"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.groupClasses.archiveClass("GROUP_CLASSE_ID")

era group_classes archive_class GROUP_CLASSE_ID

{
  "name": "era__group_classes__archive_class",
  "arguments": {
    "id": "GROUP_CLASSE_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold group_classes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_found, class_archived, has_upcoming_joinings, no_workspace · 429 slow down

group_classes.cancel_joining

Cancel a class booking — Frees the place. A reason is required, as in the source.

Needs group_classes:write · removes or cannot be undone · asks a person to confirm when Era runs it

• Canonical address: POST /api/v1/actions/group_classes.cancel_joining

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: group_classes.joining_cancelled

What it writes: group_class_joining (update) — Marks it cancelled and records why

curl -X POST https://app.getera.io/api/v1/group_class_joinings/GROUP_CLASS_JOINING_ID/actions/cancel_joining \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"reason":"Reason"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "group_classes.joining_cancelled"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.groupClassJoinings.cancelJoining("GROUP_CLASS_JOINING_ID", {
  reason: "Reason"
})

era group_class_joinings cancel_joining GROUP_CLASS_JOINING_ID \
  --reason "Reason"

{
  "name": "era__group_classes__cancel_joining",
  "arguments": {
    "joiningId": "GROUP_CLASS_JOINING_ID",
    "reason": "Reason"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold group_classes:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 joining_not_found, already_cancelled, already_finished, unknown_reason · 429 slow down

group_classes.cancel_session

Cancel one session — Takes one date off the series and cancels everyone booked on it.

Needs group_classes:manage · removes or cannot be undone · asks a person to confirm when Era runs it

• Canonical address: POST /api/v1/actions/group_classes.cancel_session

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: group_classes.session_cancelled, group_classes.joining_cancelled

What it writes: group_class_session_cancellation (insert) — Records the cancelled date; group_class_joining (update) — Cancels everyone booked on it

curl -X POST https://app.getera.io/api/v1/group_class_joinings/actions/cancel_session \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"scheduleId":"GROUP_CLASS_SCHEDULE_ID","sessionDate":"2026-11-02","reason":"Reason"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "group_classes.session_cancelled",
    "group_classes.joining_cancelled"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.groupClassJoinings.cancelSession({
  scheduleId: "GROUP_CLASS_SCHEDULE_ID",
  sessionDate: "2026-11-02",
  reason: "Reason"
})

era group_class_joinings cancel_session \
  --schedule-id "GROUP_CLASS_SCHEDULE_ID" \
  --session-date "2026-11-02" \
  --reason "Reason"

{
  "name": "era__group_classes__cancel_session",
  "arguments": {
    "scheduleId": "GROUP_CLASS_SCHEDULE_ID",
    "sessionDate": "2026-11-02",
    "reason": "Reason"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold group_classes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 schedule_not_found, not_found, unknown_reason, no_such_session, session_cancelled, session_in_past, no_workspace · 429 slow down

group_classes.create_class

Create a class — A class with its services, its capacity and its weekly times, in one go.

Needs group_classes:manage · changes data

• Canonical address: POST /api/v1/actions/group_classes.create_class

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: group_classes.class_created

What it writes: group_class (insert) — Creates the class; group_class_service (insert) — Links its services; group_class_schedule (insert) — Writes its weekly series

curl -X POST https://app.getera.io/api/v1/group_classes/actions/create_class \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name","capacity":1,"itemVariantIds":{},"schedules":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "group_classes.class_created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.groupClasses.createClass({
  name: "Name",
  capacity: 1,
  itemVariantIds: {},
  schedules: {}
})

era group_classes create_class --data '{"name":"Name","capacity":1,"itemVariantIds":{},"schedules":{}}'

{
  "name": "era__group_classes__create_class",
  "arguments": {
    "name": "Name",
    "capacity": 1,
    "itemVariantIds": {},
    "schedules": {}
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold group_classes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 no_services, no_schedule, service_not_found, not_a_class_service, service_not_offered_that_day, provider_cannot_perform, schedule_exists · 429 slow down

group_classes.end_schedule

End a series — The class stops running at this time after a date; later bookings are cancelled.

Needs group_classes:manage · reaches outside (sends, publishes or charges) · asks a person to confirm when Era runs it

• Canonical address: POST /api/v1/actions/group_classes.end_schedule

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: group_classes.series_ended, group_classes.joining_cancelled

What it writes: group_class_schedule (update) — Stamps ends_on; group_class_joining (update) — Cancels bookings after the last session

curl -X POST https://app.getera.io/api/v1/group_class_schedules/GROUP_CLASS_SCHEDULE_ID/actions/end_schedule \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"endsOn":"2026-11-02","reason":"Reason"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "group_classes.series_ended",
    "group_classes.joining_cancelled"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.groupClassSchedules.endSchedule("GROUP_CLASS_SCHEDULE_ID", {
  endsOn: "2026-11-02",
  reason: "Reason"
})

era group_class_schedules end_schedule GROUP_CLASS_SCHEDULE_ID \
  --ends-on "2026-11-02" \
  --reason "Reason"

{
  "name": "era__group_classes__end_schedule",
  "arguments": {
    "scheduleId": "GROUP_CLASS_SCHEDULE_ID",
    "endsOn": "2026-11-02",
    "reason": "Reason"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold group_classes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 schedule_not_found, schedule_ended, not_found, unknown_reason, ends_in_past, no_workspace · 429 slow down

group_classes.join

Book a place — Puts a customer on one session of a class, while it has room.

Needs group_classes:write · changes data

• Canonical address: POST /api/v1/actions/group_classes.join

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: group_classes.joined

What it writes: group_class_joining (insert) — Books the place, with its price frozen

curl -X POST https://app.getera.io/api/v1/group_class_joinings/actions/join \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"scheduleId":"GROUP_CLASS_SCHEDULE_ID","sessionDate":"2026-11-02","customerId":"CUSTOMER_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "group_classes.joined"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.groupClassJoinings.join({
  scheduleId: "GROUP_CLASS_SCHEDULE_ID",
  sessionDate: "2026-11-02",
  customerId: "CUSTOMER_ID"
})

era group_class_joinings join \
  --schedule-id "GROUP_CLASS_SCHEDULE_ID" \
  --session-date "2026-11-02" \
  --customer-id "CUSTOMER_ID"

{
  "name": "era__group_classes__join",
  "arguments": {
    "scheduleId": "GROUP_CLASS_SCHEDULE_ID",
    "sessionDate": "2026-11-02",
    "customerId": "CUSTOMER_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold group_classes:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 schedule_not_found, not_found, class_archived, no_such_session, session_cancelled, inside_cutoff, outside_window, class_full, customer_not_found, customer_banned, already_joined, no_workspace · 429 slow down

group_classes.join_online

Book a class place online — A visitor takes one place on a class session from the site timetable, while it has room.

Needs group_classes:write · changes data · Also callable from a published site (visitor)

• Canonical address: POST /api/v1/actions/group_classes.join_online

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: group_classes.joined

What it writes: group_class_joining (insert) — Books the place, with its price frozen

Errors: 401 no or expired credential · 403 the credential does not hold group_classes:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 guest_details_required, class_full · 429 slow down

group_classes.mark_attendance

Record attendance — Came, or did not come.

Needs group_classes:write · changes data

• Canonical address: POST /api/v1/actions/group_classes.mark_attendance

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: group_classes.attended, group_classes.no_show

What it writes: group_class_joining (update) — Moves it to completed or no_show

curl -X POST https://app.getera.io/api/v1/group_class_joinings/GROUP_CLASS_JOINING_ID/actions/mark_attendance \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"attended":true}'

{
  "ok": true,
  "result": "…",
  "events": [
    "group_classes.attended",
    "group_classes.no_show"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.groupClassJoinings.markAttendance("GROUP_CLASS_JOINING_ID", {
  attended: true
})

era group_class_joinings mark_attendance GROUP_CLASS_JOINING_ID \
  --attended true

{
  "name": "era__group_classes__mark_attendance",
  "arguments": {
    "joiningId": "GROUP_CLASS_JOINING_ID",
    "attended": true
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold group_classes:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 joining_not_found, already_cancelled, already_finished, not_yet_started, no_workspace · 429 slow down

group_classes.set_services

Change the services — Which services make up the class — and so its price.

Needs group_classes:manage · removes or cannot be undone

• Canonical address: POST /api/v1/actions/group_classes.set_services

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: group_classes.class_updated

What it writes: group_class_service (upsert) — Sets the class’s services; group_class_service (delete) — Removes the ones no longer in it

curl -X POST https://app.getera.io/api/v1/group_class_services/actions/set_services \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"GROUP_CLASS_ID","itemVariantIds":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "group_classes.class_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.groupClassServices.setServices({
  id: "GROUP_CLASS_ID",
  itemVariantIds: {}
})

era group_class_services set_services --data '{"id":"GROUP_CLASS_ID","itemVariantIds":{}}'

{
  "name": "era__group_classes__set_services",
  "arguments": {
    "id": "GROUP_CLASS_ID",
    "itemVariantIds": {}
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold group_classes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_found, class_archived, no_services, service_not_found, not_a_class_service, service_not_offered_that_day · 429 slow down

group_classes.update_class

Edit a class — Name, places and the default instructor.

Needs group_classes:manage · changes data

• Canonical address: POST /api/v1/actions/group_classes.update_class

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: group_classes.class_updated

What it writes: group_class (update) — Updates the class

curl -X POST https://app.getera.io/api/v1/group_classes/GROUP_CLASSE_ID/actions/update_class \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "group_classes.class_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.groupClasses.updateClass("GROUP_CLASSE_ID", {
  name: "Name"
})

era group_classes update_class GROUP_CLASSE_ID \
  --name "Name"

{
  "name": "era__group_classes__update_class",
  "arguments": {
    "id": "GROUP_CLASSE_ID",
    "name": "Name"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold group_classes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_found, class_archived, capacity_below_booked, provider_cannot_perform, no_workspace · 429 slow down

group_classes.update_schedule

Edit a weekly time — Length and instructor always; day and time only while nobody is booked on it.

Needs group_classes:manage · changes data

• Canonical address: POST /api/v1/actions/group_classes.update_schedule

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: group_classes.series_updated

What it writes: group_class_schedule (update) — Updates the series

curl -X POST https://app.getera.io/api/v1/group_class_schedules/GROUP_CLASS_SCHEDULE_ID/actions/update_schedule \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"weekday":1}'

{
  "ok": true,
  "result": "…",
  "events": [
    "group_classes.series_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.groupClassSchedules.updateSchedule("GROUP_CLASS_SCHEDULE_ID", {
  weekday: 1
})

era group_class_schedules update_schedule GROUP_CLASS_SCHEDULE_ID \
  --weekday 1

{
  "name": "era__group_classes__update_schedule",
  "arguments": {
    "scheduleId": "GROUP_CLASS_SCHEDULE_ID",
    "weekday": 1
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold group_classes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 schedule_not_found, schedule_ended, class_archived, no_schedule, has_upcoming_joinings, schedule_exists, service_not_offered_that_day, provider_cannot_perform · 429 slow down

Data models

GroupClassJoining

Table group_class_joining · Resource group_class_joinings

• GET /api/v1/group_class_joinings
• GET /api/v1/group_class_joinings/{id}

Primary key: id

Checks:

• CHECK ((price_amount >= 0))

GroupClassSchedule

Table group_class_schedule · Resource group_class_schedules

• GET /api/v1/group_class_schedules
• GET /api/v1/group_class_schedules/{id}

Primary key: id

Checks:

• CHECK (((starts_on IS NULL) OR (ends_on IS NULL) OR (ends_on >= starts_on)))
• CHECK ((duration > 0))
• CHECK (((weekday >= 0) AND (weekday <= 6)))

GroupClassService

Table group_class_service · Resource group_class_services

• GET /api/v1/group_class_services
• GET /api/v1/group_class_services/{id}

Primary key: id

Unique: group_class_id, item_variant_id

GroupClass

Table group_class · Resource group_classes

• GET /api/v1/group_classes
• GET /api/v1/group_classes/{id}

Primary key: id

Checks:

• CHECK ((capacity > 0))
• CHECK (((length(btrim(name)) >= 1) AND (length(btrim(name)) <= 255)))

Events

Workflows and webhooks react to these events.