Get activity group by ID

GET /api/configuration/activity-groups/{all}

Success: 200 OK

Products: Operator (FOH), Consumer (CONSUMER) (any one of these products, not all)
Features: Online Bookings (ONLINEBOOK), Front of House Generic Access (FOHGENERIC) (any one of these features, not all)

Overview

Returns one activity group and the activities filed under it. An activity group is the operator-defined family an activity belongs to — "Racket sports", "Swimming lessons" — and it is the natural way to render a booking menu one level up from individual activities. The final segment of the path is the group identifier.

The group is one level deep, not a hierarchy. Groups contain activities; they do not contain other groups. Everything you get back is the group's own detail plus a flat list of its activities.

A group with nothing in it returns 200 with an empty activities array. An identifier that matches no group returns 404 with the plain string The activity group was not found. Those are genuinely different answers here, unlike several other configuration endpoints — you can rely on 404 meaning "no such group".

Activity group and activity identifiers are tenant-specific and operator-chosen, so read them at runtime rather than hard-coding them, and do not carry them between environments. The lookup matches the identifier exactly, so case and spacing must agree with the identifier as configured.

Each activity here is summary-level only. You get the identifier, the label, a comment and the display colours — not the type, participant limits, image, tags or translations. For those, call get activity details with the activity's id.

Like the other consumer-facing activity reads, this endpoint is available anonymously, so a public booking journey can build its category pages before anyone signs in.

Endpoint

GET {base_url}/api/configuration/activity-groups/{all}

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

Name	Type	Required	Description
`activityGroupId`	string	Yes	The activity group's identifier, up to 15 characters — as returned by the list-activity-groups endpoint, or as `activityGroupId` on an activity's detail. Groups created without an explicit identifier are given one prefixed `ACTGRP`. It is matched exactly, so a value in the wrong case or with stray whitespace returns `404`.

Sample request

cURL

curl -X GET '{base_url}/api/configuration/activity-groups/{all}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Response fields

Field	Type	Description
`description`	string	Maximum 255 characters.
`id`	string	Maximum 15 characters.
`comments`	string	Free-text notes about the group, intended for display alongside its name. The value returned is the group's web comments; it is null when the operator has not set any, so treat it as optional supporting copy rather than something to rely on.
`activities`	array of object	The activities filed under this group, in summary form. An empty array, not null, when the group has no activities — that is a valid configuration, not an error. Each entry carries only enough to render a list; call get activity details with an entry's `id` for the type, participant limits, image, tags and translations. Note that activities in a group can belong to different sites, and this response does not tell you which, so fetch the detail or the site-filtered list if that matters.
`activities[].id`	string	Maximum 15 characters.
`activities[].description`	string	Maximum 255 characters.
`activities[].comments`	string	Free-text notes about the activity. The value is taken from the first of the activity's general comments and its web comments that is set, so the same field can carry either depending on how the operator configured it. Null when neither is set.
`activities[].backColourHex`	string	The background colour the operator has assigned to this activity, as `#RRGGBB`. Returned as an empty string, not null, when no colour is set. Purely presentational — it carries no booking meaning.
`activities[].textColourHex`	string	The foreground colour to pair with `backColourHex`, in the same `#RRGGBB` form and likewise an empty string when unset. The two are stored independently, so one can be set without the other — do not assume a usable contrast pair.

Sample response

200 OK

{
  "description": "string",
  "id": "string",
  "comments": "string",
  "activities": [
    {
      "id": "string",
      "description": "string",
      "comments": "string",
      "backColourHex": "string",
      "textColourHex": "string"
    }
  ]
}

Errors

Status	Meaning	When
`400`	Bad request	The activity group ID must be specified.
`404`	Not found	The activity group was not found.
`500`	Internal server error	The group or activity read failed. The body is empty.

This page as markdown · All pages · llms.txt