List gig contracts

​

A signed contract or addendum on a gig, as imported from the band’s paper: its number, when it was signed, the PDF, and the lines and discounts it sold, which carry its id. Its total is their sum, computed, and should equal the total the PDF prints.

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, gig_id, kind, number, header, footer, signed_at, attachment_id, created_time, last_edited_time, id. Default: created_time.

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

  • filter[gig_id]

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

  • filter[kind]

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

  • filter[number]

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

  • filter[header]

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

  • filter[footer]

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

  • filter[signed_at]

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

  • filter[attachment_id]

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

  • filter[created_time]

    Shorthand filter[created_time]=value means 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]=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/gig-contracts
curl 'https://api.weddingoperatingsystems.com/api/v1/gig-contracts?limit=50&offset=0&sort=created_time' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "label": null,
      "gig_id": null,
      "kind": "contract",
      "number": null,
      "header": null,
      "footer": null,
      "signed_at": null,
      "attachment_id": null,
      "created_time": "2026-10-08T19:05:34.884Z",
      "last_edited_time": "2026-10-08T19:05:34.884Z",
      "amount_total": 1
    }
  ],
  "meta": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

A page of gig contracts.

A Wedding Operating Systems, LLC product hireorpheus.com