Workouts

Retrieve a paged list of workout events (updates or deletes) since a given date. Events are ordered from newest to oldest. The intention is to allow clients to keep their local cache of workouts up to date without having to fetch the entire list of workouts.

Returns a paginated array of workout events, indicating updates or deletions.

get/v1/workouts/events

Request

Base URL: https://api.hevyapp.com (the document declares no server; this is the origin it was published from)
URL: https://api.hevyapp.com/v1/workouts/events
Auth: none declared. Required headers: api-key

Query parameters

pageinteger

Page number (Must be 1 or greater)

pageSizeinteger

Number of items on the requested page (Max 10)

sincestring

Headers

api-keystring uuid required

Response

A paginated list of workout events

pageinteger required

The current page number

page_countinteger required

The total number of pages available

Example response

{
  "page": 1,
  "page_count": 5,
  "events": [
    {
      "type": "updated",
      "workout": {
        "id": "b459cba5-cd6d-463c-abd6-54f8eafcadcb",
        "title": "Morning Workout 💪",
        "routine_id": "b459cba5-cd6d-463c-abd6-54f8eafcadcb",
        "description": "Pushed myself to the limit today!",
        "start_time": "2021-09-14T12:00:00Z",
        "end_time": "2021-09-14T12:00:00Z",
        "updated_at": "2021-09-14T12:00:00Z",
        "created_at": "2021-09-14T12:00:00Z",
        "exercises": [
          {
            "title": "Bench Press (Barbell)",
            "notes": "Paid closer attention to form today. Felt great!",
            "exercise_template_id": "05293BCA",
            "sets": [
              {
                "type": "normal",
                "weight_kg": 100,
                "reps": 10,
                "rpe": 9.5,
                "custom_metric": 50
              }
            ]
          }
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.