List gig role invitations

​

An invitation round for a gig_role (legacy event_role_invitations in gig language): who was asked, when, and how they responded. invitation_number increments per role.

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: gigRoleId, staffMemberId, invitationNumber, invitedAt, emailSentAt, respondedAt, response, notes, createdTime, lastEditedTime, id. Default: -invitationNumber.

  • fields
    Type: string

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

  • filter[gigRoleId]

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

    • Type: stringFormat: uuid

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

  • filter[staffMemberId]

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

    • Type: stringFormat: uuid

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

  • filter[invitationNumber]

    Shorthand filter[invitationNumber]=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[invitationNumber]=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[invitedAt]

    Shorthand filter[invitedAt]=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[invitedAt]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • filter[emailSentAt]

    Shorthand filter[emailSentAt]=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[emailSentAt]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • filter[respondedAt]

    Shorthand filter[respondedAt]=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[respondedAt]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • filter[response]

    Shorthand filter[response]=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[response]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, 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[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/gig-role-invitations
curl 'https://api.weddingoperatingsystems.com/api/v1/gig-role-invitations?limit=50&offset=0&sort=-invitationNumber' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "gigRoleId": null,
      "staffMemberId": null,
      "invitationNumber": null,
      "invitedAt": null,
      "emailSentAt": null,
      "respondedAt": null,
      "response": null,
      "notes": null,
      "createdTime": "2026-09-30T06:22:05.745Z",
      "lastEditedTime": "2026-09-30T06:22:05.745Z"
    }
  ],
  "meta": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

A page of gig role invitations.