Wger Exercise API

openapi: 3.2.0
info:
  title: wger Exercise API
  version: 2.7.0a2
  description: Self hosted FLOSS workout and fitness tracker.
  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: ''
      summary: Exercise list
      x-summary-source: derived
    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: ''
      summary: Exercise create
      x-summary-source: derived
  /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: ''
      summary: Exercise retrieve
      x-summary-source: derived
    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: ''
      summary: Exercise update
      x-summary-source: derived
    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: ''
      summary: Exercise partial update
      x-summary-source: derived
    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
      summary: Exercise destroy
      x-summary-source: derived
components:
  schemas:
    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
    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
    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'
  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
x-provenance:
  method: harvested
  publisher: Wger
  source: https://wger.de/api/v2/schema
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)