Tours

A tour is the top-level container in Daysync — it holds days, schedule items, venues, accommodation, guest lists, and bulletins. Tours are identified by a UUID string. All endpoints require the standard authentication headers.

List tours

GET /v1/tours?org_id={orgId}

Returns every tour in an organization that the authenticated user can see. Scope: tours.read Query parameters

Name	Type	Required	Description
`org_id`	string (UUID)	Yes	The organization to list tours for.

Example

curl "$BASE/v1/tours?org_id=2f1c…" \
  -H "x-api-key: $KEY" -H "x-api-secret: $SECRET" -H "Authorization: Bearer $TOKEN"

Response data — array of tour memberships:

{
  "status": true,
  "message": "Success",
  "data": [
    {
      "role": "ADMIN",
      "member_count": 8,
      "tour": {
        "id": "2f1c…",
        "name": "Spring Tour 2026",
        "image": "https://…",
        "fileName": "cover.jpg",
        "start_date": "2026-06-01T00:00:00Z",
        "end_date": "2026-06-30T00:00:00Z",
        "is_archived": false,
        "is_deleted": false,
        "tourDays": [
          { "id": 1843, "day": { "id": 1843, "name": "Day 1", "date": "2026-06-01T00:00:00Z", "time_zone": "Australia/Sydney" } }
        ],
        "created_by": { "id": "…", "firstname": "Jane", "lastname": "Doe", "email": "jane@…", "image": "https://…" }
      }
    }
  ]
}

role — the authenticated user’s role on the tour.
member_count — number of members on the tour.
tour.tourDays — the tour’s days; each day id is used as dayId in schedule and guest-list routes.

Create a tour

POST /v1/tours

Scope: tours.write Body

Field	Type	Required	Description
`name`	string	Yes	Tour name (1–500 characters).
`org_id`	string (UUID)	Yes	Organization the tour belongs to.
`start_date`	ISO 8601 datetime	Yes	Tour start.
`end_date`	ISO 8601 datetime	Yes	Tour end. Must be ≥ `start_date`.
`timeZone`	string (IANA)	Yes	e.g. `Australia/Sydney`.
`days`	array<Day>	Yes	One or more days (see below). Must be non-empty.
`image`	string	No	Cover image URL.
`fileName`	string	No	Cover image file name.
`avatarColor`	string	No	Avatar colour.
`avatarColorId`	number	No	Avatar colour ID — valid values.
`is_demo`	boolean	No	Marks the tour as demo data.

Day object (days[])

Field	Type	Required	Description
`day_type_id`	number	Yes	Day type — see List Day Types for valid values.
`name`	string	Yes	Day name.
`formatted_address`	string	Yes	Display address for the day.
`date`	ISO 8601 datetime	Yes	The day’s date.
`place_id`	string	No	Maps place ID.
`timeZone`	string (IANA)	No	Day time zone.
`viewport`	Viewport	No	`{ northeast: {lat,lng}, southwest: {lat,lng} }`.

Example

curl -X POST "$BASE/v1/tours" \
  -H "x-api-key: $KEY" -H "x-api-secret: $SECRET" -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Spring Tour 2026",
    "org_id": "2f1c…",
    "start_date": "2026-06-01T00:00:00Z",
    "end_date": "2026-06-30T00:00:00Z",
    "timeZone": "Australia/Sydney",
    "days": [
      { "day_type_id": 1, "name": "Day 1", "formatted_address": "Sydney NSW", "date": "2026-06-01T00:00:00Z" }
    ]
  }'

Response data: { "id": "2f1c…" } — the new tour’s ID.

Tour creation is subject to the subscription requirement (402) for non-exempt organizations, and to the validation rules in Errors.

Edit a tour

PUT /v1/tours/{tourId}

Scope: tours.write Path parameters

Name	Type	Description
`tourId`	string (UUID)	Tour to edit.

Body — all fields optional; send only what you want to change.

Field	Type	Description
`name`	string	Tour name (1–500 chars when provided).
`start_date`	ISO 8601 datetime	New start.
`end_date`	ISO 8601 datetime	New end (must be ≥ `start_date`).
`timeZone`	string (IANA)	New time zone.
`image`	string	Cover image URL.
`fileName`	string	Cover image file name.
`avatarColorId`	number	Avatar colour ID — valid values.
`day_list`	array<EditTourDay>	Declarative full list of the tour’s days — see the warning below. Each entry may include `day_id`, `day_type_id`, `name`, `formatted_address`, `place_id`, `date`, `timeZone`, `viewport`. Entries with a `day_id` update that day; entries without one create a new day.

day_list replaces the tour’s day set — omitted days are permanently deleted, including everything on them.When you send day_list, any existing day whose day_id is not in the list is hard-deleted (not soft-deleted), and the deletion cascades to all content on that day — schedule items, guest list entries, and day-scoped links are destroyed and cannot be recovered through the API.To safely update one day:

GET /v1/tours?org_id=… and collect every day.id from the tour’s tourDays.
Send day_list containing all existing days (just { "day_id": … } is enough to preserve one unchanged), with your modifications on the day you’re editing.

If you only want to change tour-level fields (name, dates, timeZone, …), omit day_list entirely — days are untouched when the field is absent.

Response data: none (status + message only).

Delete a tour

DELETE /v1/tours/{tourId}

Soft-deletes the tour. After deletion, any request referencing the tour returns 404 TOUR_NOT_FOUND. Scope: tours.write Path parameters

Name	Type	Description
`tourId`	string (UUID)	Tour to delete.

Response data: none.

Read a whole tour in one call

GET /v1/tours/{tourId}/data

Returns a tour’s days — each with its own date, name, day type, time zone and location, plus the schedule items, venues, stays, guest list entries, bulletins and pass types on it. Everything you would otherwise assemble from six separate endpoints per day, and from a second GET /v1/tours call to find out which day is which. Scope: tours.read — plus schedule.read, venues.read, accommodation.read, guestlist.read and bulletins.read.

This endpoint requires more than one scope. Because a single response spans six resources, a partner holding only tours.read cannot use it as a side door — you must hold all six read scopes. Missing any one returns 403 INSUFFICIENT_SCOPE, and the message names exactly which are absent — see Scopes → Endpoints that need more than one scope, which lists the others.

Query parameters — all optional.

Name	Type	Description
`dayIds`	string	Comma-separated integer day IDs, e.g. `1843,1844`. Restricts the response to those days.
`scheduleLimit`	number	Max schedule items per day.
`staysLimit`	number	Max stays per day.
`guestLimit`	number	Max guest list entries per day.
`bulletinLimit`	number	Max bulletins per day.
`skipEmptyDays`	boolean	Omit days with no content.

Each *Limit is clamped to 500. A response covering six resources across every day of a long tour can approach Lambda’s 6 MB ceiling, so the limits are capped rather than letting the response be truncated or the call fail. Pass dayIds and skipEmptyDays to keep responses small on long tours.A malformed dayIds (anything that isn’t a comma-separated list of integers) returns 400 VALIDATION_ERROR rather than being ignored — a typo must not quietly widen the response to the whole tour. Each *Limit must be a positive integer.

Example

curl "$BASE/v1/tours/2f1c…/data?dayIds=1843,1844&scheduleLimit=100&skipEmptyDays=true" \
  -H "x-api-key: $KEY" -H "x-api-secret: $SECRET" -H "Authorization: Bearer $TOKEN"

Response data

{
  "days": [
    {
      "id": 1843,
      "name": "Day 1",
      "date": "2026-06-01",
      "time_zone": "Australia/Sydney",
      "type_id": { "id": 1, "type": "Show", "description": "Show day" },
      "formattedAddress": "1 Macquarie St, Sydney NSW 2000, Australia",
      "placeFormattedAddress": "Sydney Opera House, Sydney",
      "place_id": "ChIJ3S-JXmauEmsRUcIaWtf4MzE",
      "viewport": {
        "northeast": { "lat": -33.855, "lng": 151.221 },
        "southwest": { "lat": -33.859, "lng": 151.213 }
      },
      "scheduleCount": 12,
      "accommodationCount": 1,
      "guestListCount": 8,
      "bulletinCount": 2,
      "venueCount": 1,
      "passTypeCount": 1,
      "truncated": false,
      "scheduleItems": [
        {
          "id": 9021, "name": "Soundcheck",
          "start_time": "14:00:00", "end_time": "15:00:00", "allDay": false,
          "status_type": { "id": 1, "type": "CONFIRMED" },
          "item_type": { "id": 3, "type": "EVENT" },
          "is_everyone": true, "is_admin_only": false,
          "schedule_item_tags": [ { "tag": { "id": 1340, "name": "Press", "color": { "id": 2, "type": "red" } } } ]
        }
      ],
      "venueItems": [
        { "id": 512, "title": "Main Hall", "formatted_address": "123 Main St", "city": "Sydney", "country": "Australia", "timezone": "Australia/Sydney", "venue_category": { "id": 1, "type": "commercial" }, "is_everyone": true, "is_admin_only": false }
      ],
      "accommodations": [
        { "id": 318, "title": "Grand Hotel", "street_address": "1 George St", "city": "Sydney", "country": "Australia", "check_in_date_time": "2026-06-01T15:00:00Z", "check_out_date_time": "2026-06-03T10:00:00Z", "is_confirmed": true, "is_everyone": true, "is_admin_only": false }
      ],
      "guestLists": [
        { "id": 77, "firstName": "Jane", "lastName": "Doe", "numberOfGuests": 2, "status": { "id": 1, "type": "APPROVED" } }
      ],
      "bulletins": [ { "id": 41, "title": "Load-in change", "body": "Rear dock", "is_pinned": true, "posted_at": "2026-05-30T02:00:00Z" } ],
      "passTypes": [ { "id": 9, "name": "Guest", "abbv": "G" } ]
    }
  ]
}

Day fields Each day identifies itself, so you do not need a second GET /v1/tours call and a client-side join on the day ID. These field names are identical to the day object inside List tours, so the two reads are interchangeable for day identity.

Field	Type	Description
`id`	integer	Day ID — use as `dayId` in the schedule and guest-list routes.
`name`	string \| null	Day name, as set on the tour.
`date`	string (`YYYY-MM-DD`) \| null	The day’s date.
`time_zone`	string (IANA) \| null	e.g. `Australia/Sydney`.
`type_id`	object \| null	The configured day type: `{ id, type, description }`. `id` is a stable day type ID and `type` is its display name. `null` when the day has no type set.
`formattedAddress`	string \| null	Display address for the day.
`placeFormattedAddress`	string \| null	Address as returned by the place lookup, when one was used.
`place_id`	string \| null	Maps place ID.
`viewport`	object \| null	`{ northeast: {lat,lng}, southwest: {lat,lng} }`.
`scheduleCount`, `accommodationCount`, `guestListCount`, `bulletinCount`, `venueCount`, `passTypeCount`	integer	The true total for the day, even when a `*Limit` or the response budget truncated the corresponding array.
`truncated`	boolean	`true` when at least one collection on this day carries fewer rows than its own count. Read the rest through that day’s own paged endpoint.

A field that the day does not have is returned as an explicit null, never omitted — so "type_id": null means “this day has no day type”, which is distinguishable from a field this API cannot supply.

This is a leaner projection than the per-resource endpoints — it carries the fields useful for an overview, not every field. When you need a full record, read it from its own endpoint (GET /v1/venues/{venueId}, GET /v1/accommodation/{accommodationId}, and so on). The *Count fields are the true totals for the day even when a *Limit truncated the corresponding array.

dayIds is scoped to the tour in the path. A day ID belonging to a different tour is simply absent from the response — it behaves exactly like an ID that does not exist.

Day sheet

A day sheet is one tour day rendered the way a production office prints it: header, running order, venues, stays, a consolidated key-contact list, guest-list totals, bulletins, and a strip of the next few days. Two endpoints — read the model, then render it. Both require tours.read plus schedule.read, venues.read, accommodation.read, guestlist.read and bulletins.read, for the same reason the whole-tour read does: one response spans all six resources. See Scopes. Everything is filtered to what the authenticated user can see. A private schedule item they are not on is absent from the model and from the PDF.

Read the day sheet model

GET /v1/tours/{tourId}/days/{dayId}/day-sheet/data

Returns the assembled sheet as data, so you can decide what to include before rendering — or use it instead of the PDF if you are laying the day out yourself. Query parameters

Name	Type	Description
`locale`	string	Reserved. Only `en` is honoured today.

Response data

Field	Type	Description
`data`	object	The day sheet model — header, schedule, venues, stays, contacts, guest list, bulletins, upcoming days.
`defaultOptions`	object	The everything-on scope for this caller. The ids in here are exactly the ids the render endpoint will accept.
`locale`	string	The locale actually used.

Take defaultOptions, switch off what you do not want, and post the result back as options. You never have to construct the option shape yourself, and you cannot accidentally name an id the caller cannot see.

Render the PDF

POST /v1/tours/{tourId}/days/{dayId}/day-sheet

Renders the day and returns a short-lived signed URL. Non-destructive: it creates nothing on the tour and changes no record. Body — all optional.

Field	Type	Description
`preset`	`FULL` \| `SCHEDULE` \| `MINIMAL`	Starting scope. Defaults to `FULL`.
`options`	object	Per-section overrides, merged over the preset. Same shape as `defaultOptions` above.
`locale`	string	Reserved. Only `en` is honoured today.
`disposition`	`INLINE` \| `ATTACHMENT`	How the signed URL serves the file. Defaults to `INLINE`.

tourId and dayId come from the path. A tourId or dayId in the body is ignored, so a body cannot redirect the render at another tenant’s day.

Example

curl -X POST "$BASE/v1/tours/2f1c…/days/1843/day-sheet" \
  -H "x-api-key: $KEY" -H "x-api-secret: $SECRET" -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "preset": "SCHEDULE", "disposition": "ATTACHMENT" }'

Response data

{
  "url": "https://…",
  "expiresAt": "2026-08-28T04:35:00Z",
  "fileName": "Spring-Tour-2026-Day-1.pdf",
  "pageCount": 3,
  "bytes": 184213,
  "key": "day-sheets/…",
  "ignoredIdCount": 0,
  "cached": false
}

Field	Type	Description
`url`	string	Signed download URL.
`expiresAt`	ISO 8601	When the URL stops working.
`fileName`	string	Suggested download name, already sanitised.
`pageCount`	integer	Pages in the rendered PDF.
`bytes`	integer	Size of the PDF.
`key`	string	Content-addressed storage key — an identical request reuses the same object.
`ignoredIdCount`	integer	How many ids you named in `options` were not available to you and were dropped. The ids themselves are never returned.
`cached`	boolean	`true` when the object already existed and nothing was re-rendered.

url is signed and short-lived. Fetch it or hand it to the user straight away; do not store it, embed it, or treat it as a permanent link. Call the endpoint again for a fresh one — a repeat call with the same options is served from cache (cached: true) and does not re-render.

Check ignoredIdCount. A non-zero value means the sheet you received is narrower than the one you asked for, because some ids you named are not visible to this user. The request still succeeds — it does not fail, and it does not tell you which ids were dropped, so that it cannot be used to probe for records on the tour.

List tour members

GET /v1/tours/{tourId}/users

Returns the tour’s members and any pending invites. Scope: users.read Path parameters

Name	Type	Description
`tourId`	string (UUID)	Tour to list members for.

Response data

{
  "tour_users": [
    {
      "id": "…",
      "user": { "id": "…", "firstname": "Jane", "lastname": "Doe", "email": "jane@…", "phone_number": "+61…", "image": "https://…" },
      "user_role_type": { "id": 1, "name": "Admin", "description": "Full access" }
    }
  ],
  "pending_invites": [ { "id": "…", "email": "newuser@…" } ]
}

List Day Types

GET /v1/day-types

Returns the valid day_type_id values used in the days array when creating or editing a tour. Scope: tours.read No parameters. Day types are global — the same list applies to every organization and tour. Example

curl "$BASE/v1/day-types" \
  -H "x-api-key: $KEY" -H "x-api-secret: $SECRET" -H "Authorization: Bearer $TOKEN"

Response data — array of day types:

{
  "status": true,
  "message": "Success",
  "data": [
    { "id": 1, "type": "…", "description": "…" }
  ]
}

Field	Type	Description
`id`	number	Use as `day_type_id` when creating/editing tours.
`type`	string	Display name of the day type.
`description`	string	Longer description.

Call this once and cache the result — day types change rarely. Fetch the live list rather than hardcoding IDs.

See also: Schedule, Venues, Accommodation, Guest List, Bulletins.

Get started

Endpoints

Guides

Reference

List tours

Create a tour

Edit a tour

Delete a tour

Read a whole tour in one call

Day sheet

Read the day sheet model

Render the PDF

List tour members

List Day Types

​List tours

​Create a tour

​Edit a tour

​Delete a tour

​Read a whole tour in one call

​Day sheet

​Read the day sheet model

​Render the PDF

​List tour members

​List Day Types

List tours

Create a tour

Edit a tour

Delete a tour

Read a whole tour in one call

Day sheet

Read the day sheet model

Render the PDF

List tour members

List Day Types