Get Workshop Entry

Retrieve a single workshop entry by ID.

Endpoint

GET /v1/workshop/{id}

Authentication

Requires an API key with the products:read scope.

Parameters

Parameter	Type	Location	Description
id	integer	path	The workshop entry ID

Response

Success (200 OK)

{
  "data": {
    "id": 1,
    "product": {
      "id": 5,
      "name": "Mountain Bike"
    },
    "variation": {
      "id": 3,
      "name": "Large, Red"
    },
    "inventory": {
      "id": 12,
      "identifier": "Bike #5",
      "unique_identifier": "SN-00012"
    },
    "quantity": 1,
    "status": "in_workshop",
    "reason": "maintenance",
    "scheduled_start_at": null,
    "scheduled_end_at": "2026-02-05T17:00:00+00:00",
    "auto_complete": false,
    "added_to_workshop_at": "2026-02-01T09:00:00+00:00",
    "removed_from_workshop_at": null,
    "is_overdue": false,
    "notes_count": 2,
    "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-01T10:00:00+00:00"
  }
}

Response Fields

Field	Type	Description
id	integer	Unique identifier
product	object	Product details
variation	object	Variation details (if applicable)
inventory	object	Inventory item details (for item-level tracking)
quantity	integer	Quantity in workshop (for group-level tracking)
status	string	scheduled, in_workshop, or completed
reason	string	maintenance, repair, cleaning, other, or null
scheduled_start_at	string	When item is scheduled to enter workshop (ISO 8601)
scheduled_end_at	string	When item is scheduled to leave workshop (ISO 8601)
auto_complete	boolean	Whether to auto-complete when scheduled_end_at is reached
added_to_workshop_at	string	When item actually entered workshop (ISO 8601)
removed_from_workshop_at	string	When item left workshop (ISO 8601)
is_overdue	boolean	Whether the entry is overdue
notes_count	integer	Number of notes on this entry
assignees	array	Assigned people, including staff without logins; each has staff_id, user_id, name, assigned_by, and assigned_at

Example Request

curl -X GET "https://app.equipdash.com/api/v1/workshop/1" \
  -H "Authorization: Bearer YOUR_API_KEY"

Errors

Status	Code	Description
401	authentication_required	No API key provided
403	insufficient_scope	API key lacks products:read scope
404	resource_not_found	Workshop entry not found

See Assign Workshop Staff for assignment actions and nullable IDs.