Myzone Accounts API

The Accounts API from Myzone — 6 operation(s) for accounts.

GitHub OpenAPI

Operations 9

GET /v1/accounts/ Retrieve a list of user accounts #
POST /v1/accounts/ Register a new user account #
GET /v1/accounts/{accountId} Get details of a specific user account #
PUT /v1/accounts/{accountId} Update an existing user account #
GET /v1/accounts/{accountId}/devices Get devices associated with an account #
POST /v1/accounts/{accountId}/devices Add a myzone device to an account #
DELETE /v1/accounts/{accountId}/devices/{deviceId} Remove a myzone device from an account #
GET /v1/accounts/{accountId}/stats Get stats associated with an account #
PATCH /v1/facilities/{facilityId}/removeaccounts Remove accounts from a facility #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/myzone:myzone-accounts-api"
All apis
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.

Get an API 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 Specification

myzone-accounts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: external-api Accounts API
  description: The Myzone external API
  version: 1.0.0
servers:
- url: https://ext-api.myzone.org
  description: Live API
tags:
- name: Accounts
paths:
  /v1/accounts/:
    get:
      tags:
      - Accounts
      summary: Retrieve a list of user accounts
      description: 'Retrieves a **paginated list** of user accounts.


        Optional filters can be applied to refine the results, such as `externalId` which can be used to filter accounts based on your own identifier.'
      parameters:
      - name: externalId
        in: query
        description: The user's external ID.
        required: false
        schema:
          type: string
      - name: facilityId
        in: query
        description: The facility ID to filter down the results
        required: false
        schema:
          type: string
          format: uuid
      - name: creationDate
        in: query
        description: Filter result by account creation date from this date. RFC3339 without milliseconds.
        required: false
        schema:
          type: string
        example: YYYY-MM-DDTHH:mm:ssZ
      - 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: Successfully retrieved the list of accounts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedAccounts'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
      security:
      - OAuth2:
        - read:accounts
      operationId: getV1Accounts
      x-operation-id-source: derived
    post:
      tags:
      - Accounts
      summary: Register a new user account
      description: 'Creates a new user account and assigns a unique `accountId`.


        Upon success, the API returns a unique `accountId` for the newly created account.


        **Note:**

        - Users must be at least 16 years old to register.

        - Emails must be unique.

        - The user must set their own password once the account has been created. Via https://auth.myzone.org/passwordreset/'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountPostBody'
      responses:
        '200':
          description: Successfully created a new account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
      security:
      - OAuth2:
        - write:accounts
      operationId: postV1Accounts
      x-operation-id-source: derived
  /v1/accounts/{accountId}:
    get:
      tags:
      - Accounts
      summary: Get details of a specific user account
      description: 'Retrieves detailed information about a user account identified by `accountId`.

        The response includes personal details, contact information, and other relevant account data.'
      parameters:
      - name: accountId
        in: path
        description: The requested account's ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved account details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountFields'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
      security:
      - OAuth2:
        - read:accounts
      operationId: getV1AccountsByAccountId
      x-operation-id-source: derived
    put:
      tags:
      - Accounts
      summary: Update an existing user account
      description: 'Modifies the details of an existing user account identified by `accountId`.


        The request allows updating user information such as firstname, surname and email.


        **Note:**

        - Partial updates are supported, meaning only the fields provided in the request body will be updated.

        - This endpoint does not support updating sensitive attributes like `dob` or `sex`.

        - `email` is the users communication email. You cannot change their login credentials.'
      parameters:
      - name: accountId
        in: path
        description: The requested account's ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatableAccountFields'
      responses:
        '200':
          description: Successfully updated account details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountFields'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
      security:
      - OAuth2:
        - write:accounts
      operationId: putV1AccountsByAccountId
      x-operation-id-source: derived
  /v1/accounts/{accountId}/devices:
    get:
      tags:
      - Accounts
      summary: Get devices associated with an account
      description: 'Retrieves all devices linked to the account identified by `accountId`.

        This includes wearable devices and integrations (e.g., MYZONE, APPLE, ANDROID).'
      parameters:
      - name: accountId
        in: path
        description: The requested account's ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved devices for the account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Devices'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
      security:
      - OAuth2:
        - read:accounts
      operationId: getV1AccountsByAccountIdDevices
      x-operation-id-source: derived
    post:
      tags:
      - Accounts
      summary: Add a myzone device to an account
      description: Adds a myzone device to an account, only one myzone device per account is allowed. If the account already has a myzone device assigned it will be replaced. An additional loan device can also be added.
      parameters:
      - name: accountId
        in: path
        description: The requested account's ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountDevicePostBody'
      responses:
        '200':
          description: Successfully created device
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Devices'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
      security:
      - OAuth2:
        - write:accounts
      operationId: postV1AccountsByAccountIdDevices
      x-operation-id-source: derived
  /v1/accounts/{accountId}/devices/{deviceId}:
    delete:
      tags:
      - Accounts
      summary: Remove a myzone device from an account
      description: Removes a myzone device from an account
      parameters:
      - name: accountId
        in: path
        description: The requested account's ID
        required: true
        schema:
          type: string
      - name: deviceId
        in: path
        description: The requested device's ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successfully created device
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Devices'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
      security:
      - OAuth2: []
      operationId: deleteV1AccountsByAccountIdDevicesByDeviceId
      x-operation-id-source: derived
  /v1/accounts/{accountId}/stats:
    get:
      tags:
      - Accounts
      summary: Get stats associated with an account
      description: 'Retrieves all stats linked to the account identified by `accountId`.


        Stats include current **rank** (i.e Copper, Iron ... HOF etc), **total MEPs** and **aggregated data on meps, calories and number of moves**.'
      parameters:
      - name: accountId
        in: path
        description: The requested account's ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved stats for the account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stats'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
      security:
      - OAuth2:
        - read:accounts
      operationId: getV1AccountsByAccountIdStats
      x-operation-id-source: derived
  /v1/facilities/{facilityId}/removeaccounts:
    patch:
      tags:
      - Accounts
      summary: Remove accounts from a facility
      description: Removes the provided lists of accounts from a facility and moves them to their countries default facility
      parameters:
      - name: facilityId
        in: path
        description: The requested facility's ID
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityRemoveAccounts'
      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:accounts
      operationId: patchV1FacilitiesByFacilityIdRemoveaccounts
      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:
    AccountPostBody:
      required:
      - dob
      - email
      - facilityId
      - firstname
      - sex
      - surname
      type: object
      properties:
        facilityId:
          type: string
          format: uuid
        email:
          type: string
          format: email
        firstname:
          maxLength: 64
          type: string
        lastname:
          maxLength: 64
          type: string
        nickname:
          maxLength: 64
          type: string
        dob:
          type: string
          format: date
        sex:
          type: integer
          description: 'The account holder''s sex assigned at birth:


            0 -> male


            1 -> female

            '
        mobile:
          type: string
        externalId:
          type: string
        commPreferences:
          $ref: '#/components/schemas/AccountPostBody_commPreferences'
        emailVerified:
          type: boolean
          description: The users email has been vefiried by the facility. This stops the user having to verfiy their email adresses themselves.
        countryISO:
          type: string
          description: The user's country of origin. ISO 3166 aplha-2 code.
          example: GB
    PagedAccounts:
      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/AccountFields'
    FacilityRemoveAccounts:
      required:
      - accountIds
      type: object
      properties:
        accountIds:
          type: string
          description: Comma seperated list of account's ID to remove from the facility
    Device:
      type: object
      properties:
        deviceId:
          type: string
          description: The device's unique identifier.
        type:
          type: string
          description: The type of device.
    inline_response_200:
      type: object
      properties:
        accountId:
          type: string
          description: The unique identifier of the newly created account.
          format: uuid
    AccountDevicePostBody:
      required:
      - deviceId
      type: object
      properties:
        deviceId:
          type: integer
    Aggregates:
      type: object
      properties:
        mepsWeek:
          type: integer
        mepsMonth:
          type: integer
        mepsYear:
          type: integer
        kcalWeek:
          type: integer
        kcalMonth:
          type: integer
        kcalYear:
          type: integer
        movesWeek:
          type: integer
        movesMonth:
          type: integer
        movesYear:
          type: integer
    UpdatableAccountFields:
      type: object
      properties:
        firstname:
          maxLength: 64
          type: string
          description: The user's first name.
        surname:
          maxLength: 64
          type: string
          description: The user's last name.
        email:
          maxLength: 100
          type: string
          description: The user's email address.
          format: email
        nickname:
          maxLength: 8
          type: string
          description: The user's nickname.
        mobile:
          type: string
          description: The user's mobile phone number.
        commPreferences:
          $ref: '#/components/schemas/AccountPostBody_commPreferences'
        facilityId:
          type: string
          description: The user's facility. This can be changed to any facility in the authenticated clients facility claims.
          format: uuid
        countryISO:
          type: string
          description: The user's country of origin. ISO 3166 aplha-2 code.
          example: AR
    Devices:
      type: array
      description: An array of devices.
      items:
        $ref: '#/components/schemas/Device'
    AccountPostBody_commPreferences:
      type: object
      properties:
        postWorkout:
          type: boolean
          description: The user receives post workout emails
        challengeInvite:
          type: boolean
          description: The user receives challenge invite emails
        survey:
          type: boolean
          description: The user receives survey and feedback emails
        marketing:
          type: boolean
          description: The user receives marketing emails
        sms:
          type: boolean
          description: The user can be contacted by sms
        whatsApp:
          type: boolean
          description: The user can be contact by whatsapp
    Stats:
      type: object
      properties:
        accountId:
          type: string
          format: uuid
        rank:
          type: string
        plus:
          type: integer
          description: The amount of months they have over the user's rank
        totalMeps:
          type: integer
        aggregates:
          $ref: '#/components/schemas/Aggregates'
    AccountFields:
      type: object
      properties:
        accountId:
          type: string
          description: The user's account identifier.
          format: uuid
        facilityId:
          type: string
          format: uuid
        email:
          maxLength: 100
          type: string
          description: The user's email address.
          format: email
        firstname:
          maxLength: 64
          type: string
          description: The user's first name.
        surname:
          maxLength: 64
          type: string
          description: The user's last name.
        nickname:
          maxLength: 8
          type: string
          description: The user's nickname.
        dob:
          type: string
          description: The user's date of birth.
          format: date
        sex:
          type: integer
          description: 'The account holder''s sex assigned at birth:


            0 -> male


            1 -> female

            '
        mobile:
          type:
          - string
          - 'null'
          description: The user's mobile phone number.
        externalId:
          type: string
          description: The user's external ID.
        profileImage:
          type: string
          description: The url to the user's profile image
        commPreferences:
          $ref: '#/components/schemas/AccountPostBody_commPreferences'
        creationDate:
          type: string
          description: Account creation date. RFC3339 without milliseconds.
          example: YYYY-MM-DDTHH:mm:ssZ
        countryISO:
          type:
          - string
          - 'null'
          description: The user's country of origin. ISO 3166 aplha-2 code.
          example: GB
  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