RoadOps Developer Docs

List events

GET/v1/teams/{teamId}/days/{dayId}/events

Lists event records for a day.

Required scopes: event:read

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`query.limit`	`integer` Maximum number of records to return. Defaults to 50 and is capped at 200.
`query.cursor`	`string` Cursor returned by page.nextCursor from the previous list response.

Response 200

`data`	`object[]`
`data[].dayId`	`string:uuid`
`data[].venueId`	`string:uuid`
`data[].name`	`string`
`data[].notes`	`string`
`data[].visibility`	`object` Optional visibility rules for the event.
`data[].visibility.groupIds`	`string:uuid[]`
`data[].visibility.userIds`	`string:uuid[]`
`data[].contacts`	`object[]`
`data[].contacts[].name`	`string` Contact person's name.
`data[].contacts[].title`	`string` Contact person's role or job title.
`data[].contacts[].phone`	`string` Contact phone number.
`data[].contacts[].email`	`string:email` Contact email address.
`data[].contacts[].notes`	`string` Short notes about this contact.
`data[].laborCalls`	`object[]`
`data[].laborCalls[].id`	`string:uuid`
`data[].laborCalls[].laborCall`	`string`
`data[].laborCalls[].time`	`object`
`data[].laborCalls[].isNextDay`	`boolean`
`data[].laborCalls[].type`	`string`
`data[].laborCalls[].location`	`string`
`data[].laborCalls[].add`	`string`
`data[].laborCalls[].cut`	`string`
`data[].laborCalls[].notes`	`string`
`data[].guestList`	`object`
`data[].guestList.enabled`	`boolean`
`data[].guestList.ticketsAllotted`	`integer \| null`
`data[].guestList.cutoffAt`	`string:date-time`
`data[].guestList.willCallPickupInstructions`	`string \| null`
`data[].guestList.seats`	`object[]`
`data[].guestList.seats[].id`	`string:uuid`
`data[].guestList.seats[].section`	`string`
`data[].guestList.seats[].row`	`string`
`data[].guestList.seats[].seat`	`string`
`data[].guestList.seats[].ticketTypeId`	`string:uuid`
`data[].guestList.seats[].assignedGuestRequestId`	`string:uuid`
`data[].guestList.ticketTypeAllotments`	`object[]`
`data[].guestList.ticketTypeAllotments[].ticketTypeId`	`string:uuid`
`data[].guestList.ticketTypeAllotments[].quantity`	`integer`
`data[].id`	`string:uuid`
`data[].orgId`	`string:uuid`
`data[].isDeleted`	`boolean`
`data[].version`	`integer` Current event aggregate version.
`data[].cursor`	`integer` Latest event-ledger cursor projected into this event record.
`page`	`object`
`page.limit`	`integer` Maximum number of records returned in this page.
`page.nextCursor`	`string \| null` Cursor to pass as the next request's cursor query parameter, or null when there are no more results.
`meta`	`object`
`meta.cursor`	`number \| null` Highest record cursor represented by this response.

Response: List events

{
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000601",
      "dayId": "00000000-0000-4000-8000-000000000201",
      "venueId": "00000000-0000-4000-8000-000000000701",
      "name": "Show",
      "notes": "Main performance event.",
      "visibility": {
        "userIds": [
          "00000000-0000-4000-8000-000000000101"
        ]
      },
      "orgId": "00000000-0000-4000-8000-000000000100",
      "contacts": [],
      "laborCalls": [],
      "guestList": {
        "enabled": true,
        "ticketsAllotted": null,
        "cutoffAt": null,
        "willCallPickupInstructions": null,
        "seats": [],
        "ticketTypeAllotments": []
      },
      "isDeleted": false,
      "version": 1,
      "cursor": 87234
    }
  ],
  "page": {
    "limit": 50,
    "nextCursor": null
  },
  "meta": {
    "cursor": 87234
  }
}

Create an event

POST/v1/teams/{teamId}/days/{dayId}/events

Accepts a command to create an event for a day.

Required scopes: event:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

`dayId`required	`string:uuid` Day identifier that owns this event.
`venueId`required	`string:uuid` Venue identifier for this event.
`name`	`string` Event display name.
`notes`	`string` Event notes.
`visibility`	`object` Optional visibility rules for this event.
`visibility.groupIds`	`string:uuid[]`
`visibility.userIds`	`string:uuid[]`
`contacts`	`object[]` Event contacts. Defaults to an empty list when omitted.
`contacts[].name`required	`string` Contact person's name.
`contacts[].title`	`string` Contact person's role or job title.
`contacts[].phone`	`string` Contact phone number.
`contacts[].email`	`string:email` Contact email address.
`contacts[].notes`	`string` Short notes about this contact.
`laborCalls`	`object[]` Labor calls for the event. Defaults to an empty list when omitted.
`laborCalls[].id`required	`string:uuid`
`laborCalls[].laborCall`required	`string`
`laborCalls[].time`required	`object`
`laborCalls[].isNextDay`required	`boolean`
`laborCalls[].type`required	`string`
`laborCalls[].location`required	`string`
`laborCalls[].add`required	`string`
`laborCalls[].cut`required	`string`
`laborCalls[].notes`required	`string`
`guestList`	`object` Guest list settings. Defaults to an enabled guest list with no seats or ticket allotments when omitted.
`guestList.enabled`	`boolean`
`guestList.ticketsAllotted`	`integer \| null`
`guestList.cutoffAt`	`string:date-time`
`guestList.willCallPickupInstructions`	`string \| null`
`guestList.seats`	`object[]`
`guestList.seats[].id`required	`string:uuid`
`guestList.seats[].section`required	`string`
`guestList.seats[].row`required	`string`
`guestList.seats[].seat`required	`string`
`guestList.seats[].ticketTypeId`	`string:uuid`
`guestList.seats[].assignedGuestRequestId`	`string:uuid`
`guestList.ticketTypeAllotments`	`object[]`
`guestList.ticketTypeAllotments[].ticketTypeId`required	`string:uuid`
`guestList.ticketTypeAllotments[].quantity`required	`integer`
`id`	`string:uuid` Optional caller-supplied event ID. RoadOps generates one when omitted.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Retrieve an event

GET/v1/teams/{teamId}/days/{dayId}/events/{eventId}

Returns one event record by ID.

Required scopes: event:read

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`path.eventId`required	`string:uuid` Event identifier.

Response 200

`data`	`object`
`data.dayId`	`string:uuid`
`data.venueId`	`string:uuid`
`data.name`	`string`
`data.notes`	`string`
`data.visibility`	`object` Optional visibility rules for the event.
`data.visibility.groupIds`	`string:uuid[]`
`data.visibility.userIds`	`string:uuid[]`
`data.contacts`	`object[]`
`data.contacts[].name`	`string` Contact person's name.
`data.contacts[].title`	`string` Contact person's role or job title.
`data.contacts[].phone`	`string` Contact phone number.
`data.contacts[].email`	`string:email` Contact email address.
`data.contacts[].notes`	`string` Short notes about this contact.
`data.laborCalls`	`object[]`
`data.laborCalls[].id`	`string:uuid`
`data.laborCalls[].laborCall`	`string`
`data.laborCalls[].time`	`object`
`data.laborCalls[].isNextDay`	`boolean`
`data.laborCalls[].type`	`string`
`data.laborCalls[].location`	`string`
`data.laborCalls[].add`	`string`
`data.laborCalls[].cut`	`string`
`data.laborCalls[].notes`	`string`
`data.guestList`	`object`
`data.guestList.enabled`	`boolean`
`data.guestList.ticketsAllotted`	`integer \| null`
`data.guestList.cutoffAt`	`string:date-time`
`data.guestList.willCallPickupInstructions`	`string \| null`
`data.guestList.seats`	`object[]`
`data.guestList.seats[].id`	`string:uuid`
`data.guestList.seats[].section`	`string`
`data.guestList.seats[].row`	`string`
`data.guestList.seats[].seat`	`string`
`data.guestList.seats[].ticketTypeId`	`string:uuid`
`data.guestList.seats[].assignedGuestRequestId`	`string:uuid`
`data.guestList.ticketTypeAllotments`	`object[]`
`data.guestList.ticketTypeAllotments[].ticketTypeId`	`string:uuid`
`data.guestList.ticketTypeAllotments[].quantity`	`integer`
`data.id`	`string:uuid`
`data.orgId`	`string:uuid`
`data.isDeleted`	`boolean`
`data.version`	`integer` Current event aggregate version.
`data.cursor`	`integer` Latest event-ledger cursor projected into this event record.
`meta`	`object`
`meta.cursor`	`integer` Highest record cursor represented by this response.

Update an event

PATCH/v1/teams/{teamId}/days/{dayId}/events/{eventId}

Accepts a command to update event fields.

Required scopes: event:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`path.eventId`required	`string:uuid` Event identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

`expectedVersion`	`integer` Optional aggregate version guard.
`updates`required	`object`
`updates.name`	`string` Updated event name.
`updates.venueId`	`string:uuid` Updated venue identifier.
`updates.notes`	`string \| null` Updated event notes, or null to clear them.
`updates.visibility`	`object \| null` Updated visibility rules, or null to clear them.
`updates.visibility.groupIds`	`string:uuid[]`
`updates.visibility.userIds`	`string:uuid[]`
`updates.contacts`	`object[]` Updated event contact list.
`updates.contacts[].name`required	`string` Contact person's name.
`updates.contacts[].title`	`string` Contact person's role or job title.
`updates.contacts[].phone`	`string` Contact phone number.
`updates.contacts[].email`	`string:email` Contact email address.
`updates.contacts[].notes`	`string` Short notes about this contact.
`updates.laborCalls`	`object[]` Updated labor calls for the event.
`updates.laborCalls[].id`required	`string:uuid`
`updates.laborCalls[].laborCall`required	`string`
`updates.laborCalls[].time`required	`object`
`updates.laborCalls[].isNextDay`required	`boolean`
`updates.laborCalls[].type`required	`string`
`updates.laborCalls[].location`required	`string`
`updates.laborCalls[].add`required	`string`
`updates.laborCalls[].cut`required	`string`
`updates.laborCalls[].notes`required	`string`
`updates.guestList`	`object` Guest list settings to update.
`updates.guestList.enabled`	`boolean`
`updates.guestList.ticketsAllotted`	`integer \| null`
`updates.guestList.cutoffAt`	`string:date-time`
`updates.guestList.willCallPickupInstructions`	`string \| null`
`updates.guestList.seats`	`object[]`
`updates.guestList.seats[].id`required	`string:uuid`
`updates.guestList.seats[].section`required	`string`
`updates.guestList.seats[].row`required	`string`
`updates.guestList.seats[].seat`required	`string`
`updates.guestList.seats[].ticketTypeId`	`string:uuid`
`updates.guestList.seats[].assignedGuestRequestId`	`string:uuid`
`updates.guestList.ticketTypeAllotments`	`object[]`
`updates.guestList.ticketTypeAllotments[].ticketTypeId`required	`string:uuid`
`updates.guestList.ticketTypeAllotments[].quantity`required	`integer`

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Delete an event

DELETE/v1/teams/{teamId}/days/{dayId}/events/{eventId}

Accepts a command to delete an event.

Required scopes: event:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`path.eventId`required	`string:uuid` Event identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Events

List events

Parameters

Response 200

Create an event

Parameters

Request body (application/json)

Response 202

Retrieve an event

Parameters

Response 200

Update an event

Parameters

Request body (application/json)

Response 202

Delete an event

Parameters

Response 202