Equipment

List equipment

Returns a paginated list of Equipment configured at the given site. Use this to populate an admin equipment-management view, or to verify equipment IDs before assigning them to appointment types.

Requires the SETTINGS_VIEW permission on the site.

get/shop/equipment

Query parameters

site_idstring required

Filter results by the site they belong to

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

A paginated list of Equipment items configured at the site.

Example response

{
  "data": [
    {
      "id": "5f1234567890abcdef123456",
      "name": "Steam Machine A",
      "description": "Lucas Champion steam unit serviced annually.",
      "quantity": 2,
      "site_id": "11111111-1111-1111-1111-111111111111",
      "organisation_id": "22222222-2222-2222-2222-222222222222"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.