Equipment Statuses

Reference for the equipment_statuses 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_statuses is the read-only catalog of install states — the valid equipment_status_id values on a customer equipment create (required). The public slug matches v3; the table is equipment_status.

Ids are platform-seeded and stable:

Visible to any caller holding Customer Equipment. There is no on/off flag — the list is non-deleted rows only.

curl "https://portal.securitytrax.com/acme/user/v4/equipment_statuses" \
  -H "Authorization: Bearer stx_acme_..."

Filter by name (matches anywhere). Sort by id, name, or sort; GET /{id} fetches one. Soft-deleted statuses return 404 by id and are omitted from the list.

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 Status

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. An unsupported filter parameter returns 422. See Filtering collections for matching semantics.

Sorting

GET .../equipment_statuses?sort= orders the list by: id, name, sort. 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.