List EGYM membership type groups
GET /api/configuration/egym/membership-type-groups
Success: 200 OK
- Products: Operator (
FOH), Integrations (INTEGRATIONS) (any one of these products, not all) - Features: Front of House Generic Access (
FOHGENERIC),EGYMSYNC(any one of these features, not all)
Overview
Lists the membership type groups enabled for the EGYM integration. Only members with an active membership in one of these groups, at a site enabled for EGYM, are sent to EGYM. The groups apply to every EGYM site in your tenant, not per site, and they decide who is included in both the initial sync and the ongoing real-time sync.
The response is the group identifiers only. To show a group's name, match each identifier to the id returned by Get all membership type groups. To change the set, use Update EGYM membership type groups.
Endpoint
GET {base_url}/api/configuration/egym/membership-type-groups
{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.
Sample request
curl -X GET '{base_url}/api/configuration/egym/membership-type-groups' \
-H 'Authorization: Bearer {accessToken}' \
-H 'X-Use-SSO: true'Response fields
| Field | Type | Description |
|---|---|---|
[] | array of string | The identifiers of the enabled membership type groups, each up to 15 characters, in no guaranteed order. An empty array means no group is enabled, so no members are sent to EGYM from any site. |
Sample response
[
"FULL",
"STAFF"
]Errors
| Status | Meaning | When |
|---|---|---|
401 | Unauthorised | The Authorization header is missing or the token is invalid or expired. |
403 | Forbidden | The token is a member or anonymous token, or does not carry the products or features this endpoint requires. |
500 | Internal server error | An unexpected server-side failure. The body is empty. The call reads only, so it is safe to retry. |