Myzone Groups API
The Groups API from Myzone — 5 operation(s) for groups.
The Groups API from Myzone — 5 operation(s) for groups.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/myzone:myzone-groups-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: external-api Groups API
description: The Myzone external API
version: 1.0.0
servers:
- url: https://ext-api.myzone.org
description: Live API
tags:
- name: Groups
paths:
/v1/facilities/{facilityId}/groups:
get:
tags:
- Groups
summary: Retrieve a list of groups
description: Returns a **paginated list** of groups availble to the facility
parameters:
- name: facilityId
in: path
description: The requested facility's ID
required: true
schema:
type: string
format: uuid
- name: limit
in: query
description: The number of records to fetch.
required: false
schema:
maximum: 100
minimum: 1
type: integer
default: 10
- name: offset
in: query
description: The number of records skipped.
required: false
schema:
minimum: 0
type: integer
default: 0
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/PagedGroups'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
security:
- OAuth2:
- read:groups
operationId: getV1FacilitiesByFacilityIdGroups
x-operation-id-source: derived
/v1/facilities/{facilityId}/groups/{groupId}:
delete:
tags:
- Groups
summary: Delete a group
description: Deletes a group from the facility
parameters:
- name: facilityId
in: path
description: The requested facility's ID
required: true
schema:
type: string
format: uuid
- name: groupId
in: path
description: The requested groups's ID
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Successful response
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
security:
- OAuth2:
- delete:groups
operationId: deleteV1FacilitiesByFacilityIdGroupsByGroupId
x-operation-id-source: derived
/v1/facilities/{facilityId}/groups/{groupId}/users:
patch:
tags:
- Groups
summary: Add/Remove accounts from a group
description: Adds/Removes the provided lists of accounts to a group
parameters:
- name: facilityId
in: path
description: The requested facility's ID
required: true
schema:
type: string
format: uuid
- name: groupId
in: path
description: The requested groups's ID
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GroupAssignPostBody'
responses:
'200':
description: Successful response
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'409':
$ref: '#/components/responses/409Error'
security:
- OAuth2:
- write:groups
operationId: patchV1FacilitiesByFacilityIdGroupsByGroupIdUsers
x-operation-id-source: derived
/v1/groups:
post:
tags:
- Groups
summary: Create a group
description: Creates a group in the facility.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GroupPostBody'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/GroupCreated'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'409':
$ref: '#/components/responses/409Error'
security:
- OAuth2:
- write:groups
operationId: postV1Groups
x-operation-id-source: derived
/v1/groups/accounts:
get:
tags:
- Groups
summary: Retrieve a list of groups
description: Returns a **paginated list** of groups associated with the accounts.
parameters:
- name: accountIds
in: query
description: Comma seperated list of account's ID
required: true
schema:
type: string
- name: limit
in: query
description: The number of records to fetch.
required: false
schema:
maximum: 100
minimum: 1
type: integer
default: 10
- name: offset
in: query
description: The number of records skipped.
required: false
schema:
minimum: 0
type: integer
default: 0
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_1'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
security:
- OAuth2:
- read:groups
operationId: getV1GroupsAccounts
x-operation-id-source: derived
components:
responses:
409Error:
description: Conflict
content:
application/json:
schema:
type: object
properties:
error:
type: string
401Error:
description: Unauthorized request
content:
application/json:
schema:
type: object
properties:
error:
type: string
403Error:
description: Forbidden request
content:
application/json:
schema:
type: object
properties:
error:
type: string
404Error:
description: Endpoint not found
content:
application/json:
schema:
type: object
properties:
error:
type: string
400Error:
description: Invalid request
content:
application/json:
schema:
type: object
properties:
error:
type: string
schemas:
Group:
type: object
properties:
id:
type: string
format: uuid
facilityId:
type: string
format: uuid
name:
type: string
type:
type: string
color:
type: string
PagedGroups:
type: object
properties:
limit:
maximum: 100
minimum: 1
type: integer
example: 1
offset:
minimum: 0
type: integer
total:
type: integer
example: 1
items:
type: array
items:
$ref: '#/components/schemas/Group'
inline_response_200_1:
type: object
properties:
accountId:
type: string
groups:
type: array
items:
$ref: '#/components/schemas/Group'
GroupPostBody:
required:
- color
- facilityId
- name
- type
type: object
properties:
facilityId:
type: string
format: uuid
name:
type: string
color:
type: string
example: '#000000'
GroupCreated:
type: object
properties:
groupId:
type: string
format: uuid
GroupAssignPostBody:
required:
- accountIds
type: object
properties:
addAccountIds:
type: string
description: Comma seperated list of account's ID to add to the group
removeAccountIds:
type: string
description: Comma seperated list of account's ID remove from teh group
securitySchemes:
OAuth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://auth.myzone.org/access_token
scopes:
read:accounts: client has read access to account api
write:accounts: client has write access to accounts api
read:moves: client has read access to moves api
read:biometrics: client has read access to biometrics api
write:biometrics: client has write access to biometrics api
read:classes_and_bookings: client has read access to classes and bookings api
write:classes_and_bookings: client has write access to classes and bookings api
delete:classes_and_bookings: client has delete access to classes and bookings api
read:challenges: client has read access to challenges api
read:facilities: client has read access to facilities api
read:reports: client has read access to reports api
read:groups: client has read access to groups api
write:groups: client has write access to groups api
delete:groups: client has delete access to groups api
read:moves:hr: client has read access to heart rate data
authorizationCode:
authorizationUrl: https://auth.myzone.org/authorize
tokenUrl: https://auth.myzone.org/access_token
scopes:
read:accounts: client has read access to account api
write:accounts: client has write access to accounts api
read:moves: client has read access to moves api
read:biometrics: client has read access to biometrics api
write:biometrics: client has write access to biometrics api
read:classes_and_bookings: client has read access to classes and bookings api
write:classes_and_bookings: client has write access to classes and bookings api
delete:classes_and_bookings: client has delete access to classes and bookings api
read:challenges: client has read access to challenges api
read:facilities: client has read access to facilities api
read:reports: client has read access to reports api
read:groups: client has read access to groups api
write:groups: client has write access to groups api
delete:groups: client has delete access to groups api
x-provenance:
method: searched
source: https://docs.myzone.org/reference
harvested: '2026-11-16'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.myzone.org/reference/delete_v1-accounts-accountid-devices-deviceid.md
- https://docs.myzone.org/reference/delete_v1-classes-occurrences-bookings-bookingid.md
- https://docs.myzone.org/reference/delete_v1-facilities-facilityid-groups-groupid.md
- https://docs.myzone.org/reference/delete_v1-webhooks-id.md
- https://docs.myzone.org/reference/get_v1-accounts-accountid-biometrics.md
- https://docs.myzone.org/reference/get_v1-accounts-accountid-devices.md
- https://docs.myzone.org/reference/get_v1-accounts-accountid-stats.md
- https://docs.myzone.org/reference/get_v1-biometrics.md
- https://docs.myzone.org/reference/get_v1-challenges-challengeid-leaderboard.md
- https://docs.myzone.org/reference/get_v1-challenges.md
- https://docs.myzone.org/reference/get_v1-classes-shared.md
- https://docs.myzone.org/reference/get_v1-facilities-facilityid-groups.md
- https://docs.myzone.org/reference/get_v1-facilities-facilityid-reports-report.md
- https://docs.myzone.org/reference/get_v1-facilities.md
- https://docs.myzone.org/reference/get_v1-groups-accounts.md
- https://docs.myzone.org/reference/get_v1-moves-accountid-moveid.md
- https://docs.myzone.org/reference/get_v1-moves-moveid-reports-report.md
- https://docs.myzone.org/reference/get_v1-webhooks.md
- https://docs.myzone.org/reference/getv1accounts.md
- https://docs.myzone.org/reference/getv1accountsaccountid.md
- https://docs.myzone.org/reference/getv1classes.md
- https://docs.myzone.org/reference/getv1classesclassid.md
- https://docs.myzone.org/reference/getv1classesclassidoccurrences.md
- https://docs.myzone.org/reference/getv1classesoccurrencesoccurrenceid.md
- https://docs.myzone.org/reference/getv1classesoccurrencesoccurrenceidbookings.md
- https://docs.myzone.org/reference/getv1classtemplates.md
- https://docs.myzone.org/reference/getv1movesaccountid.md
- https://docs.myzone.org/reference/patch_v1-classes-classid-delete.md
- https://docs.myzone.org/reference/patch_v1-classes-occurrences-bookings-bookingid-delete.md
- https://docs.myzone.org/reference/patch_v1-facilities-facilityid-groups-groupid-users.md
- https://docs.myzone.org/reference/patch_v1-facilities-facilityid-removeaccounts.md
- https://docs.myzone.org/reference/post_v1-accounts-accountid-devices.md
- https://docs.myzone.org/reference/post_v1-groups.md
- https://docs.myzone.org/reference/post_v1-webhooks.md
- https://docs.myzone.org/reference/postv1accounts.md
- https://docs.myzone.org/reference/postv1classes.md
- https://docs.myzone.org/reference/postv1classesoccurrencesoccurrenceidbookings.md
- https://docs.myzone.org/reference/put_v1-accounts-accountid-biometrics.md
- https://docs.myzone.org/reference/putv1accountsaccountid.md
- https://docs.myzone.org/reference/putv1classesclassid.md
- https://docs.myzone.org/reference/putv1classesoccurrencesoccurrenceid.md
merge:
pages: 41
deduped: 224
conflicts_kept_first: 0