Wger Exercise API

openapi: 3.2.0
info:
  title: wger Exercise API
  version: 2.7.0a2
  description: "Self hosted FLOSS workout and fitness tracker.\n\n## Authentication\n\nSystem-wide data such as the exercise database, ingredients and units can be\nread without authenticating. Everything tied to a user account needs one of the\nfollowing, which are tried in this order:\n\n* `Authorization: Token <key>` with a personal API key. Users create one on the\n  API key page of their profile, e.g. `/en/user/api-key`.\n* `Authorization: Bearer <token>` with a JWT access token.\n* The session cookie, which is what a logged-in browser uses.\n\n## Pagination\n\nList endpoints take `limit` and `offset`, and answer with `count`, `next`,\n`previous` and `results`. The default page size is 20 and `limit` is capped\nat 999.\n\n`/api/v2/ingredient-sync/` is the exception. It uses cursor pagination so that\nsyncing the catalogue stays fast no matter how far a client has paginated. That\nresponse carries no `count`, and clients follow `next` instead of picking an\noffset.\n\n## Filtering and ordering\n\nMost list endpoints accept filters on a subset of their fields, plus `ordering`\nwith a field name that can be prefixed with `-` to reverse it. Both are listed\nper endpoint.\n\n## Unknown fields are dropped on write\n\nA field that the endpoint does not declare is ignored instead of rejected. Such\na request still answers 200 or 201, and the unknown field simply has no effect,\nso check a write against the response body rather than the status code.\n\n## Rate limits\n\nThe ingredient endpoints are rate limited because the catalogue holds millions\nof rows, and creating exercises is capped as well. Limits count per user for\nauthenticated callers and per IP otherwise. Exceeding one answers 429.\n"
  license:
    name: AGPL-3.0-or-later
    url: https://www.gnu.org/licenses/agpl-3.0.html
servers:
- url: /
  description: This server
- url: https://wger.de
  description: The "official" upstream wger instance
tags:
- name: exercise
  description: The exercise database. Related objects are referenced by ID. This is the writable endpoint of the two exercise representations.
paths:
  /api/v2/exercise/:
    get:
      operationId: exercise_list
      description: 'API endpoint for exercise objects.


        For a read-only endpoint with all the information of an exercise, see /api/v2/exerciseinfo/'
      parameters:
      - in: query
        name: category
        schema:
          type: integer
      - in: query
        name: equipment
        schema:
          type: array
          items:
            type: integer
        explode: true
        style: form
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: muscles
        schema:
          type: array
          items:
            type: integer
        explode: true
        style: form
      - in: query
        name: muscles_secondary
        schema:
          type: array
          items:
            type: integer
        explode: true
        style: form
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      tags:
      - exercise
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedExerciseList'
          description: ''
    post:
      operationId: exercise_create
      description: 'API endpoint for exercise objects.


        For a read-only endpoint with all the information of an exercise, see /api/v2/exerciseinfo/'
      tags:
      - exercise
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExerciseRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exercise'
          description: ''
  /api/v2/exercise/{id}/:
    get:
      operationId: exercise_retrieve
      description: 'API endpoint for exercise objects.


        For a read-only endpoint with all the information of an exercise, see /api/v2/exerciseinfo/'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this exercise.
        required: true
      tags:
      - exercise
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exercise'
          description: ''
    put:
      operationId: exercise_update
      description: 'API endpoint for exercise objects.


        For a read-only endpoint with all the information of an exercise, see /api/v2/exerciseinfo/'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this exercise.
        required: true
      tags:
      - exercise
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExerciseRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exercise'
          description: ''
    patch:
      operationId: exercise_partial_update
      description: 'API endpoint for exercise objects.


        For a read-only endpoint with all the information of an exercise, see /api/v2/exerciseinfo/'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this exercise.
        required: true
      tags:
      - exercise
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedExerciseRequest'
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exercise'
          description: ''
    delete:
      operationId: exercise_destroy
      description: 'API endpoint for exercise objects.


        For a read-only endpoint with all the information of an exercise, see /api/v2/exerciseinfo/'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this exercise.
        required: true
      tags:
      - exercise
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '204':
          description: No response body
components:
  schemas:
    PaginatedExerciseList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/Exercise'
    Exercise:
      type: object
      description: Exercise serializer
      properties:
        id:
          type: integer
          readOnly: true
        uuid:
          type: string
          format: uuid
          readOnly: true
        created:
          type: string
          format: date-time
          readOnly: true
          title: Creation date
        last_update:
          type: string
          format: date-time
          readOnly: true
        category:
          type: integer
        muscles:
          type: array
          items:
            type: integer
            title: Primary muscles
          title: Primary muscles
        muscles_secondary:
          type: array
          items:
            type: integer
            title: Secondary muscles
          title: Secondary muscles
        equipment:
          type: array
          items:
            type: integer
        variation_group:
          type:
          - string
          - 'null'
          format: uuid
        license_author:
          type: string
          title: Author(s)
          description: If you are not the author, enter the name or source here.
          maxLength: 3500
      required:
      - category
      - created
      - id
      - last_update
      - uuid
    ExerciseRequest:
      type: object
      description: Exercise serializer
      properties:
        category:
          type: integer
        muscles:
          type: array
          items:
            type: integer
            title: Primary muscles
          title: Primary muscles
        muscles_secondary:
          type: array
          items:
            type: integer
            title: Secondary muscles
          title: Secondary muscles
        equipment:
          type: array
          items:
            type: integer
        variation_group:
          type:
          - string
          - 'null'
          format: uuid
        license_author:
          type: string
          title: Author(s)
          description: If you are not the author, enter the name or source here.
          maxLength: 3500
      required:
      - category
    PatchedExerciseRequest:
      type: object
      description: Exercise serializer
      properties:
        category:
          type: integer
        muscles:
          type: array
          items:
            type: integer
            title: Primary muscles
          title: Primary muscles
        muscles_secondary:
          type: array
          items:
            type: integer
            title: Secondary muscles
          title: Secondary muscles
        equipment:
          type: array
          items:
            type: integer
        variation_group:
          type:
          - string
          - 'null'
          format: uuid
        license_author:
          type: string
          title: Author(s)
          description: If you are not the author, enter the name or source here.
          maxLength: 3500
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    headlessJwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token issued by the allauth headless endpoints
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    oidcAuth:
      type: oauth2
      description: Access token issued by the OAuth2/OIDC provider
      flows:
        authorizationCode:
          authorizationUrl: https://wger.de/identity/o/authorize
          tokenUrl: https://wger.de/identity/o/api/token
          scopes:
            api:read: View your training, nutrition and body data
            api:write: Add and change your training, nutrition and body data
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
externalDocs:
  url: https://wger.readthedocs.io
  description: wger documentation