Skip to main content
GET
/
equipments
Get Equipment
curl --request GET \
  --url https://api.example.com/equipments
{
  "totalEquipments": 123,
  "data": [
    {
      "equipment": "<string>",
      "imageUrl": "<string>"
    }
  ]
}

Endpoint

GET /api/equipments
Retrieve a list of equipment types available in the BodyWorks database. Equipment types are used to categorize exercises and help users find exercises based on available equipment.

Query Parameters

limit
number
The maximum number of equipment types to return. If not specified, returns all available equipment.

Response

totalEquipments
number
The total number of equipment types available in the database.
data
IEquipment[]
An array of equipment objects.

Example Request

# Get all equipment types
curl -X GET "https://api.bodyworks.com/api/equipments"

# Get limited number of equipment types
curl -X GET "https://api.bodyworks.com/api/equipments?limit=10"

Example Response

{
  "totalEquipments": 15,
  "data": [
    {
      "equipment": "barbell",
      "imageUrl": "https://cdn.bodyworks.com/equipment/barbell.png"
    },
    {
      "equipment": "dumbbell",
      "imageUrl": "https://cdn.bodyworks.com/equipment/dumbbell.png"
    },
    {
      "equipment": "bodyweight",
      "imageUrl": "https://cdn.bodyworks.com/equipment/bodyweight.png"
    },
    {
      "equipment": "cable",
      "imageUrl": "https://cdn.bodyworks.com/equipment/cable.png"
    },
    {
      "equipment": "machine",
      "imageUrl": "https://cdn.bodyworks.com/equipment/machine.png"
    },
    {
      "equipment": "kettlebell",
      "imageUrl": "https://cdn.bodyworks.com/equipment/kettlebell.png"
    },
    {
      "equipment": "resistance band",
      "imageUrl": "https://cdn.bodyworks.com/equipment/resistance-band.png"
    },
    {
      "equipment": "ez bar",
      "imageUrl": "https://cdn.bodyworks.com/equipment/ez-bar.png"
    },
    {
      "equipment": "smith machine",
      "imageUrl": "https://cdn.bodyworks.com/equipment/smith-machine.png"
    },
    {
      "equipment": "stability ball",
      "imageUrl": "https://cdn.bodyworks.com/equipment/stability-ball.png"
    },
    {
      "equipment": "medicine ball",
      "imageUrl": "https://cdn.bodyworks.com/equipment/medicine-ball.png"
    },
    {
      "equipment": "foam roller",
      "imageUrl": "https://cdn.bodyworks.com/equipment/foam-roller.png"
    },
    {
      "equipment": "pull-up bar",
      "imageUrl": "https://cdn.bodyworks.com/equipment/pull-up-bar.png"
    },
    {
      "equipment": "trap bar",
      "imageUrl": "https://cdn.bodyworks.com/equipment/trap-bar.png"
    },
    {
      "equipment": "suspension trainer",
      "imageUrl": "https://cdn.bodyworks.com/equipment/suspension-trainer.png"
    }
  ]
}

Error Responses

400 Bad Request
{
  "error": "Invalid limit parameter",
  "message": "Limit must be a positive integer"
}
500 Internal Server Error
{
  "error": "Internal server error",
  "message": "Failed to fetch equipment types from database"
}

Use Cases

  • Exercise Filtering: Filter exercises by available equipment
  • Gym Setup: Help users find exercises based on their home gym equipment
  • Workout Customization: Create workouts based on equipment availability
  • Equipment Recommendations: Suggest equipment for specific training goals
  • User Interface: Populate equipment filters and selection menus

Build docs developers (and LLMs) love