Workshop Notes
Add and view notes on workshop entries for tracking work performed, issues found, or status updates.
List Notes
Retrieve all notes for a workshop entry.
Endpoint
GET /v1/workshop/{id}/notes
Authentication
Requires an API key with the products:read scope.
Parameters
| Parameter | Type | Location | Description |
|---|---|---|---|
id | integer | path | The workshop entry ID |
Response
{
"data": {
"workshop_log_id": 1,
"notes": [
{
"id": 3,
"note": "Replaced brake pads and adjusted tension",
"created_by": {
"id": 5,
"name": "John Smith"
},
"created_at": "2026-02-01T14:30:00+00:00",
"updated_at": "2026-02-01T14:30:00+00:00"
},
{
"id": 2,
"note": "Parts ordered - expected delivery tomorrow",
"created_by": {
"id": 5,
"name": "John Smith"
},
"created_at": "2026-02-01T11:00:00+00:00",
"updated_at": "2026-02-01T11:00:00+00:00"
},
{
"id": 1,
"note": "Broken brake cable - needs replacement",
"created_by": {
"id": 5,
"name": "John Smith"
},
"created_at": "2026-02-01T09:00:00+00:00",
"updated_at": "2026-02-01T09:00:00+00:00"
}
]
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-02-01T15:00:00+00:00"
}
}
Example Request
curl -X GET "https://app.equipdash.com/api/v1/workshop/1/notes" \
-H "Authorization: Bearer YOUR_API_KEY"
Add Note
Add a new note to a workshop entry.
Endpoint
POST /v1/workshop/{id}/notes
Authentication
Requires an API key with the products:write scope.
Parameters
| Parameter | Type | Location | Description |
|---|---|---|---|
id | integer | path | The workshop entry ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
note | string | Yes | Note text (max 1000 characters) |
Response
{
"data": {
"id": 4,
"note": "All work completed - ready for pickup",
"created_by": {
"id": 5,
"name": "John Smith"
},
"created_at": "2026-02-02T10:00:00+00:00",
"updated_at": "2026-02-02T10:00:00+00:00"
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-02-02T10:00:00+00:00"
}
}
Example Request
curl -X POST "https://app.equipdash.com/api/v1/workshop/1/notes" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"note": "All work completed - ready for pickup"
}'
Errors
| Status | Code | Description |
|---|---|---|
| 401 | authentication_required | No API key provided |
| 403 | insufficient_scope | API key lacks required scope |
| 404 | resource_not_found | Workshop entry not found |
| 422 | validation_error | Note text is required or too long |