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

  • Page size, 50 by default, 200 at most.

  • Records to skip.

  • 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.

  • Comma-separated subset of fields to return. id is always included.

  • Shorthand filter[label]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • Shorthand filter[gig_status_id]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • Shorthand filter[gig_type_id]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • Shorthand filter[gig_date]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

  • Shorthand filter[guest_arrival_time]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

  • Shorthand filter[start_time]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

  • Shorthand filter[end_time]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

  • Shorthand filter[venue_id]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • Shorthand filter[contract_number]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • Shorthand filter[guest_count]=value means 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.

  • Shorthand filter[notes]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • Shorthand filter[external_crm_id]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • Shorthand filter[currency]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • Shorthand filter[created_time]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

  • Shorthand filter[last_edited_time]=value means 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
Request Example for get/gigs
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
  }
}