API Reference

The Wodly platform has a public API for accessing our catalogue of workouts.

The api root path is https://wodly.net/api. All endpoints in the API return a content type of application/json.

Workout

This endpoint returns a JSON object representing the current Workout of the Day (WOD) contain a property of workout and restDatDescription. On a given day with a workout set as todays workout, the restDatDescription property will be null and the workout property will contain an object representing the workout. On days when there is no workout set, the workout property will be null and the restDatDescription property will contain a string representing the rest day description.

Sample Output (with WOD)

https://wodly.net/api/workout/wod

{ "restDayDescription": null, "workout": { "id": "025795bb-d1d3-4a5c-4c32-08d7eec11835", "name": "Push the Pace", "description": "For time\r\n27-21-15-9\r\nDumbbell Thrusters\r\n(22.5/15kg - 50/35lbs)\r\nPush Ups", "stimulus": "Fast test of pushing strength with some legs and core stability in there for good measure. This is meant to be a fast workout, push hard and keep moving. Don't be afraid to scale back to keep the pace high.", "notes": "Scale the weight of the thrusters to something you can do the first few rounds in no more than 2 sets. Break up the push ups if needed and don't go to failure, use an elevated box if needed to keep up higher rep sets.", "createdByName": "Ian Carey", "createdByAvatarUrl": "https://wodly.blob.core.windows.net/primary//Images/957b45c7-3fc7-4d73-bb06-680163bc9f73_IMG_2994.JPG", "tags": [ "Dumbbell Thrusters", "Push Ups" ] } }

Sample Output (without WOD)

https://wodly.net/api/workout/wod

{ "restDayDescription": "Spend some time reading something not on a screen", "workout": null }

This endpoint returns a JSON object of workout representing the workout as referenced by the provided id.

Params

{ id string (GUID identifier for the workout) }

Sample Output

https://wodly.net/api/workout/025795bb-d1d3-4a5c-4c32-08d7eec11835

"workout": { "id": "025795bb-d1d3-4a5c-4c32-08d7eec11835", "name": "Push the Pace", "description": "For time\r\n27-21-15-9\r\nDumbbell Thrusters\r\n(22.5/15kg - 50/35lbs)\r\nPush Ups", "stimulus": "Fast test of pushing strength with some legs and core stability in there for good measure. This is meant to be a fast workout, push hard and keep moving. Don't be afraid to scale back to keep the pace high.", "notes": "Scale the weight of the thrusters to something you can do the first few rounds in no more than 2 sets. Break up the push ups if needed and don't go to failure, use an elevated box if needed to keep up higher rep sets.", "createdByName": "Ian Carey", "createdByAvatarUrl": "https://wodly.blob.core.windows.net/primary//Images/957b45c7-3fc7-4d73-bb06-680163bc9f73_IMG_2994.JPG", "tags": [ "Dumbbell Thrusters", "Push Ups" ] }

This endpoint returns a JSON array of workout representing the search results for the provided searchTerm and pageNumber. The searchTerm is matched on the name of the workout. The default page length is 20 records. Providing the pageNumber param (n), will shift your result set down n*20 records.

Params

{ searchTerm string (matched against the name of the workout for searching) pageNumber int (responses are paged with a length of 20) }

Sample Output

https://wodly.net/api/workout?searchTerm=a

[ { "id": "f55ef193-7a4b-4323-d213-08d7ef82b655", "name": "May the 4th be With You", "description": "4 rounds for time\r\n19 Pistols\r\n77 Double Unders", "stimulus": "Odd rep scheme to celebrate the origin of Star Wars. Testing high skill movements and cardio load.", "notes": "Scale pistols with an elevated box if needed. Single unders can be done instead with some double under attempts.", "createdByName": "Ian Carey", "createdByAvatarUrl": "https://wodly.blob.core.windows.net/primary//Images/957b45c7-3fc7-4d73-bb06-680163bc9f73_IMG_2994.JPG", "tags": [ "Double Unders", "Pistols" ] }, { "id": "025795bb-d1d3-4a5c-4c32-08d7eec11835", "name": "Push the Pace", "description": "For time\r\n27-21-15-9\r\nDumbbell Thrusters\r\n(22.5/15kg - 50/35lbs)\r\nPush Ups", "stimulus": "Fast test of pushing strength with some legs and core stability in there for good measure. This is meant to be a fast workout, push hard and keep moving. Don't be afraid to scale back to keep the pace high.", "notes": "Scale the weight of the thrusters to something you can do the first few rounds in no more than 2 sets. Break up the push ups if needed and don't go to failure, use an elevated box if needed to keep up higher rep sets.", "createdByName": "Ian Carey", "createdByAvatarUrl": "https://wodly.blob.core.windows.net/primary//Images/957b45c7-3fc7-4d73-bb06-680163bc9f73_IMG_2994.JPG", "tags": [ "Dumbbell Thrusters", "Push Ups" ] }, ... ]

Reference Objects

workout { id* string (GUID unique identifier for the workout) name* string (Unique name of the workout) description* string (Description of the workout) stimulus string (Description of the desired stimulus of the workout) notes string (Scaling notes or additional notes for the workout) createdByName* string (Name of the author of the workout) createdByAvatarUrl* string (URL for the avatar of the author of the workout) tags* string[] (Movement tags for the workout) }


* value always provided, other fields can be null.