Equipment

Reference for the equipment resource. Requests follow the conventions in Requests and Responses; fields you receive and may write are filtered by your user's permissions, so responses can contain a subset of the fields below.

Operations

Not available as a standard REST operation for this resource: create, update, delete — such requests return 402 feature_not_enabled or 403 permission_denied.

How it works

equipment is the read-only catalog of equipment master items — the valid equipment_id values when creating customer equipment. equipment_id is required on create.

Only identity fields are exposed (name, sku, model, manufacturer, equipment_type_id). Dealer cost / value / bonus / par never appear here — those copy onto the customer-equipment row on create. Gated by Customer Equipment.

curl "https://portal.securitytrax.com/acme/user/v4/equipment?manufacturer=Honeywell&name=Door" \
  -H "Authorization: Bearer stx_acme_..."

Filters: name, sku, model, and manufacturer (each matches anywhere), equipment_type_id (exact), active (true / false / all; default true). Sort by id, name, sku, model, or manufacturer; GET /{id} fetches one, including an off item. Soft-deleted items return 404 by id and are omitted from the list.

Heads up. Collection kits are omitted from the list (create rejects them with 422). GET /equipment/{id} still returns a collection kit if you already have its id.

Note. The list matches the in-app picker: on items only unless you pass ?active=false or ?active=all. See Filtering collections.

Fields

Fields are grouped by the permission that gates them. A group you may not view is absent from responses; a group you may not write is rejected with 422 when sent in a write.

Equipment

View: Customer Equipment.

Pagination

The list endpoint uses client-controlled offset pagination: ?page= (1-based) and ?per_page= (default 25, max 100). The response mirrors meta.pagination (page, per_page, total, last_page) and sends an RFC5988 Link header; follow rel="next" to walk pages. See Pagination.

Filters

The list endpoint accepts these query-param filters: name, equipment_type_id, sku, model, manufacturer, active. An unsupported filter parameter returns 422. See Filtering collections for matching semantics.

Sorting

GET .../equipment?sort= orders the list by: id, name, sku, model, manufacturer. Prefix a field with - for descending; comma-separate for tie-breakers. An unsupported field returns 422. See Sorting collections.

Related

• Requests and Responses — envelope, errors, pagination, and rate limits.
• Authentication — API access tokens and the Authorization header.