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

  • limit
    Type: integer
    min:  
    0
    max:  
    200

    Page size, 50 by default, 200 at most.

  • offset
    Type: integer
    min:  
    0

    Records to skip.

  • sort
    Type: string

    Comma-separated fields; prefix with - for descending. Sortable: label, status, gigType, date, guestArrivalTime, startTime, endTime, venueId, partyName, contractNumber, guestCount, numberOfPieces, productionOnly, outdoor, bandLeaderId, coordinatorId, notes, highlightedNotes, externalCrmId, createdTime, lastEditedTime, id. Default: -date,label.

  • fields
    Type: string

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

  • filter[label]

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

    • Type: string

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

  • filter[status]

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

    • Type: stringenum

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

      values
      inquiryproposalbookedcompletedcancelled
  • filter[gigType]

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

    • Type: stringenum

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

      values
      weddingcorporateprivate_functionfundraiserdebutante_ballshowcaseother
  • filter[date]

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

    • Type: stringFormat: date

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

  • filter[guestArrivalTime]

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

    • Type: string

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

  • filter[startTime]

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

    • Type: string

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

  • filter[endTime]

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

    • Type: string

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

  • filter[venueId]

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

    • Type: stringFormat: uuid

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

  • filter[partyName]

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

    • Type: string

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

  • filter[contractNumber]

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

    • Type: string

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

  • filter[guestCount]

    Shorthand filter[guestCount]=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.

    • Type: number

      Shorthand filter[guestCount]=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.

  • filter[numberOfPieces]

    Shorthand filter[numberOfPieces]=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.

    • Type: number

      Shorthand filter[numberOfPieces]=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.

  • filter[productionOnly]

    Shorthand filter[productionOnly]=value means equals. Operators: equals, does_not_equal.

    • Type: boolean

      Shorthand filter[productionOnly]=value means equals. Operators: equals, does_not_equal.

  • filter[outdoor]

    Shorthand filter[outdoor]=value means equals. Operators: equals, does_not_equal.

    • Type: boolean

      Shorthand filter[outdoor]=value means equals. Operators: equals, does_not_equal.

  • filter[bandLeaderId]

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

    • Type: stringFormat: uuid

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

  • filter[coordinatorId]

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

    • Type: stringFormat: uuid

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

  • filter[notes]

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

    • Type: string

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

  • filter[highlightedNotes]

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

    • Type: string

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

  • filter[externalCrmId]

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

    • Type: string

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

  • filter[createdTime]

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

    • Type: stringFormat: date-time

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

  • filter[lastEditedTime]

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

    • Type: stringFormat: date-time

      Shorthand filter[lastEditedTime]=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.weddingoperatingsystems.com/api/v1/gigs?limit=50&offset=0&sort=-date%2Clabel' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "label": null,
      "status": "inquiry",
      "gigType": "wedding",
      "date": null,
      "guestArrivalTime": null,
      "startTime": null,
      "endTime": null,
      "venueId": null,
      "partyName": null,
      "contractNumber": null,
      "guestCount": null,
      "numberOfPieces": null,
      "productionOnly": true,
      "outdoor": true,
      "bandLeaderId": null,
      "coordinatorId": null,
      "notes": null,
      "highlightedNotes": null,
      "externalCrmId": null,
      "createdTime": "2026-09-30T11:22:55.092Z",
      "lastEditedTime": "2026-09-30T11:22:55.092Z"
    }
  ],
  "meta": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

A page of gigs.

© 2026 Wedding Operating Systems, LLC. All rights reserved. Book a demo