Product Checklist Defaults
Configure default checklist templates for products. When a product is added to the workshop, assigned templates are automatically attached to the workshop entry.
Templates can be assigned to products in three ways:
- All products: Set
apply_to_all_productson the template itself (see Checklist Templates) - Individual products: Assign a template to a specific product using these endpoints
- Product categories: Assign a template to a product category (templates apply to all products in that category)
Endpointsโ
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/products/{id}/checklist-defaults | List defaults |
| POST | /v1/products/{id}/checklist-defaults | Add default |
| DELETE | /v1/products/{id}/checklist-defaults/{templateId} | Remove default |
List Defaultsโ
Retrieve all checklist templates individually assigned to a product.
This only returns templates directly assigned to this product. Templates assigned via apply_to_all_products or via product category are not included in this list, but will still be auto-attached when the product enters the workshop.
Endpointโ
GET /v1/products/{id}/checklist-defaults
Authenticationโ
Requires an API key with the products:read scope.
Parametersโ
| Parameter | Type | Location | Description |
|---|---|---|---|
id | integer | path | The product ID |
Responseโ
{
"data": [
{
"id": 1,
"name": "Bike Safety Inspection",
"description": "Standard safety check for all rental bikes.",
"equipment_category": "bikes",
"is_prebuilt": true,
"apply_to_all_products": false,
"item_count": 5,
"items": [],
"archived": false,
"created_at": "2026-01-15T10:00:00+00:00",
"updated_at": "2026-01-15T10:00:00+00:00"
},
{
"id": 3,
"name": "Bike Cleaning Checklist",
"description": null,
"equipment_category": "bikes",
"is_prebuilt": false,
"apply_to_all_products": false,
"item_count": 4,
"items": [],
"archived": false,
"created_at": "2026-01-22T14:00:00+00:00",
"updated_at": "2026-01-22T14:00:00+00:00"
}
],
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-02-01T09:00:00+00:00"
}
}
Example Requestโ
curl -X GET "https://app.equipdash.com/api/v1/products/5/checklist-defaults" \
-H "Authorization: Bearer YOUR_API_KEY"
Add Defaultโ
Assign a checklist template as a default for a specific product. When this product is added to the workshop, the template will be automatically attached.
Endpointโ
POST /v1/products/{id}/checklist-defaults
Authenticationโ
Requires an API key with the products:write scope.
Parametersโ
| Parameter | Type | Location | Description |
|---|---|---|---|
id | integer | path | The product ID |
Request Bodyโ
| Field | Type | Required | Description |
|---|---|---|---|
template_id | integer | Yes | The checklist template ID to assign as default |
Response (201 Created)โ
{
"data": {
"message": "Default template added."
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-02-01T09:00:00+00:00"
}
}
Example Requestโ
curl -X POST "https://app.equipdash.com/api/v1/products/5/checklist-defaults" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"template_id": 6
}'
Remove Defaultโ
Remove a checklist template from a product's defaults. This does not affect existing workshop entries that already have this checklist attached.
Endpointโ
DELETE /v1/products/{id}/checklist-defaults/{templateId}
Authenticationโ
Requires an API key with the products:write scope.
Parametersโ
| Parameter | Type | Location | Description |
|---|---|---|---|
id | integer | path | The product ID |
templateId | integer | path | The checklist template ID to remove |
Response (204 No Content)โ
No response body.
Example Requestโ
curl -X DELETE "https://app.equipdash.com/api/v1/products/5/checklist-defaults/6" \
-H "Authorization: Bearer YOUR_API_KEY"
Errorsโ
| Status | Code | Description |
|---|---|---|
| 401 | authentication_required | No API key provided |
| 403 | insufficient_scope | API key lacks required scope |
| 404 | resource_not_found | Product or template not found |
| 422 | validation_error | Invalid request data |
| 422 | add_default_error | Template already assigned or not found |
Common Validation Errorsโ
- Template not found: The specified template ID does not exist
- Template is already a default for this product: This template is already assigned to this product
- Product not found: Product doesn't exist or doesn't belong to your account