List gigs
A booked (or prospective) engagement — the record the whole system runs around. Products, staffing, contacts, itinerary and set list all hang off a gig.
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, gig_status_id, gig_type_id, gig_date, guest_arrival_time, start_time, end_time, venue_id, contract_number, guest_count, notes, external_crm_id, currency, created_time, last_edited_time, id. Default: -gig_date,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[gig
_status _id] Shorthand
filter[gig_status_id]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.- Type: stringFormat: uuid
Shorthand
filter[gig_status_id]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.
- filter[gig
_type _id] Shorthand
filter[gig_type_id]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.- Type: stringFormat: uuid
Shorthand
filter[gig_type_id]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.
- filter[gig
_date] Shorthand
filter[gig_date]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.- Type: stringFormat: date
Shorthand
filter[gig_date]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.
- filter[guest
_arrival _time] Shorthand
filter[guest_arrival_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.- Type: string
Shorthand
filter[guest_arrival_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.
- filter[start
_time] Shorthand
filter[start_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.- Type: string
Shorthand
filter[start_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.
- filter[end
_time] Shorthand
filter[end_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.- Type: string
Shorthand
filter[end_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.
- filter[venue
_id] Shorthand
filter[venue_id]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.- Type: stringFormat: uuid
Shorthand
filter[venue_id]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.
- filter[contract
_number] Shorthand
filter[contract_number]=valuemeans equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.- Type: string
Shorthand
filter[contract_number]=valuemeans equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
- filter[guest
_count] Shorthand
filter[guest_count]=valuemeans equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.- Type: number
Shorthand
filter[guest_count]=valuemeans equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, 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[external
_crm _id] Shorthand
filter[external_crm_id]=valuemeans equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.- Type: string
Shorthand
filter[external_crm_id]=valuemeans equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
- filter[currency]
Shorthand
filter[currency]=valuemeans equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.- Type: string
Shorthand
filter[currency]=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.hireorpheus.com/api/v1/gigs?limit=50&offset=0&sort=-gig_date%2Clabel' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"label": null,
"gig_status_id": null,
"gig_type_id": null,
"gig_date": null,
"guest_arrival_time": null,
"start_time": null,
"end_time": null,
"venue_id": null,
"contract_number": null,
"guest_count": null,
"notes": null,
"external_crm_id": null,
"currency": null,
"created_time": "2026-10-14T08:02:53.591Z",
"last_edited_time": "2026-10-14T08:02:53.591Z",
"amount_subtotal": 1,
"amount_discount": 1,
"amount_total": 1
}
],
"meta": {
"total": 1,
"limit": 1,
"offset": 1
}
}