List equipment
One unit of equipment the band tracks by name: a truck, the company drum kit, a rented van. Plates, VINs and serial numbers that only one band cares about are its own custom fields.
Query Parameters
- Type: integerlimitmin:0max:200
Page size, 50 by default, 200 at most.
- Type: integeroffsetmin:0
Records to skip.
- Type: stringsort
Comma-separated fields; prefix with
-for descending. Sortable: label, equipment_type_id, identifier, ownership, status, notes, created_time, last_edited_time, id. Default: label. - Type: stringfields
Comma-separated subset of fields to return.
idis always included. - filter[label]
Shorthand
filter[label]=valuemeans equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.- Type: string
Shorthand
filter[label]=valuemeans equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
- filter[equipment
_type _id] Shorthand
filter[equipment_type_id]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.- Type: stringFormat: uuid
Shorthand
filter[equipment_type_id]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.
- filter[identifier]
Shorthand
filter[identifier]=valuemeans equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.- Type: string
Shorthand
filter[identifier]=valuemeans equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
- filter[ownership]
Shorthand
filter[ownership]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.- Type: "owned" or "rented"enum
Shorthand
filter[ownership]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.
- filter[status]
Shorthand
filter[status]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.- Type: "active" or "in_repair" or "retired"enum
Shorthand
filter[status]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.
- filter[notes]
Shorthand
filter[notes]=valuemeans equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.- Type: string
Shorthand
filter[notes]=valuemeans equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
- filter[created
_time] Shorthand
filter[created_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.- Type: stringFormat: date-time
Shorthand
filter[created_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.
- filter[last
_edited _time] Shorthand
filter[last_edited_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.- Type: stringFormat: date-time
Shorthand
filter[last_edited_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.
Responses
- application/json
- application/json
- application/json
- application/json
curl 'https://api.weddingoperatingsystems.com/api/v1/equipment?limit=50&offset=0&sort=label' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"label": null,
"equipment_type_id": null,
"identifier": null,
"ownership": "owned",
"status": "active",
"notes": null,
"created_time": "2026-10-05T21:22:26.972Z",
"last_edited_time": "2026-10-05T21:22:26.972Z"
}
],
"meta": {
"total": 1,
"limit": 1,
"offset": 1
}
}