Skip to main content
GET
/
events
Retrieve Events
curl --request GET \
  --url https://api.nuwebgroup.com/v1/events \
  --header 'Authorization: Bearer <token>'
{
  "companyId": 1,
  "companyName": "Example Company",
  "events": [
    {
      "id": 1,
      "externalId": "EVT-23123",
      "name": "Foo",
      "description": "Event description",
      "totalEventCapacity": 250,
      "remainingEventCapacity": 241,
      "totalTicketCapacity": 25,
      "remainingTicketCapacity": 21,
      "totalProductCapacity": 25,
      "remainingProductCapacity": 23,
      "totalGuestListCapacity": 25,
      "remainingGuestListCapacity": 22,
      "offSale": false,
      "isHidden": false,
      "isPublished": false,
      "isCancelled": false,
      "pageDisplayDate": "hide",
      "pageDisplayLocation": "show-all",
      "pagePricingDisplay": false,
      "minPrice": "0",
      "maxPrice": "50000",
      "start": "2021-11-22T11:59:00.000000Z",
      "end": "2021-11-22T11:59:00.000000Z",
      "tags": [
        {
          "id": 1,
          "name": "Entertainment",
          "companyId": 1,
          "categoryId": 1
        }
      ],
      "salePeriods": [
        {
          "id": 1,
          "name": "General Sale",
          "startDate": "2025-03-25T09:10:00.000000Z",
          "endDate": "2025-05-26T16:00:00.000000Z",
          "type_id": 1,
          "type": "general_sale"
        }
      ],
      "createdAt": "2021-11-22T11:59:00.000000Z",
      "updatedAt": "2021-11-22T11:59:00.000000Z",
      "deletedAt": null,
      "thumbnail": "http://api.yourdomain.com/img/event_thumb_placeholder.jpg",
      "timezone": "Europe/London",
      "hasMandatoryDataCapture": true,
      "hasOptionalDataCapture": true,
      "hasNoDataCapture": true,
      "hasTimeslots": false,
      "hasLiveStream": false,
      "hasGroups": false,
      "scheduleId": null,
      "seatingPlan": {
        "enabled": true,
        "bestAvailableSeatsEnabled": true
      },
      "isOnline": false,
      "organiserName": "Organiser Name",
      "organiserEmail": "[email protected]",
      "organiserPhone": "+441234567890",
      "venue": {
        "id": 1,
        "address": "6586 Toy Mountains Suite 596",
        "region": "Rerum",
        "city": "London",
        "name": "Et Perspiciatis",
        "postcode": "11418",
        "latitude": "51.41833890",
        "longitude": "-0.22062880",
        "deletedAt": null
      },
      "eventCodes": [
        {
          "questionId": 1,
          "answer": "The answer"
        },
        {
          "questionId": 2,
          "answer": "The answer"
        },
        {
          "questionId": 3,
          "answer": [
            1
          ]
        },
        {
          "questionId": 4,
          "answer": "2"
        },
        {
          "questionId": 5,
          "answer": "1"
        },
        {
          "questionId": 6,
          "answer": [
            4,
            5
          ]
        },
        {
          "questionId": 7,
          "answer": [
            7
          ]
        }
      ],
      "meta": {
        "lastUpdated": "2021-11-22T11:59:00.000000Z"
      },
      "media": {
        "thumbnailImage": {
          "type": "thumbnailImage",
          "id": 1,
          "attributes": {
            "modelType": "events",
            "modelId": 201,
            "collectionName": "card_thumbnail_en",
            "mimeType": "image/png",
            "size": 376634,
            "orderColumn": 1,
            "updatedAt": "2022-07-29T13:45:05.000000Z",
            "createdAt": "2022-07-29T13:45:05.000000Z",
            "url": "https://nextgen-test.s3.eu-west-1.amazonaws.com/public/media/local/1/rGcuQ9zYRYQ.png"
          }
        },
        "pageHeaderImage": {
          "type": "pageHeaderImage",
          "id": 1,
          "attributes": {
            "modelType": "events",
            "modelId": 201,
            "collectionName": "page_header_en",
            "mimeType": "image/png",
            "size": 376634,
            "orderColumn": 1,
            "updatedAt": "2022-07-29T13:45:05.000000Z",
            "createdAt": "2022-07-29T13:45:05.000000Z",
            "url": "https://nextgen-test.s3.eu-west-1.amazonaws.com/public/media/local/1/rGcuQ9zYRYQ.png"
          }
        },
        "metaImage": {
          "type": "metaImage",
          "id": 1,
          "attributes": {
            "modelType": "events",
            "modelId": 201,
            "collectionName": "meta_image_en",
            "mimeType": "image/png",
            "size": 376634,
            "orderColumn": 1,
            "updatedAt": "2022-07-29T13:45:05.000000Z",
            "createdAt": "2022-07-29T13:45:05.000000Z",
            "url": "https://nextgen-test.s3.eu-west-1.amazonaws.com/public/media/local/1/rGcuQ9zYRYQ.png"
          }
        }
      }
    }
  ],
  "tagCategories": [
    {
      "name": "Lorem",
      "id": 1,
      "companyId": 1,
      "isMandatory": 1,
      "createdBy": 1,
      "updatedBy": 1,
      "createdAt": "2021-11-22T11:59:00.000000Z",
      "updatedAt": "2021-11-22T11:59:00.000000Z",
      "deletedAt": null
    },
    {
      "name": "Ipsum",
      "id": 1,
      "companyId": 1,
      "isMandatory": 0,
      "createdBy": 1,
      "updatedBy": 1,
      "createdAt": "2021-11-22T11:59:00.000000Z",
      "updatedAt": "2021-11-22T11:59:00.000000Z",
      "deletedAt": null
    }
  ],
  "companies": [
    {
      "id": 1,
      "name": "Company A",
      "alias": "companya",
      "url": "https://companya.example.com",
      "liveMode": true
    },
    {
      "id": 2,
      "name": "Company B",
      "alias": "companyb",
      "url": "https://companyb-custom-domain.com",
      "liveMode": false
    }
  ],
  "eventSchedules": [
    {
      "id": 1,
      "name": "Theatre Schedule",
      "description": "<p>This is our number 1 theatre show.</p>",
      "type": "mixed",
      "futureEventsCount": 72,
      "startDate": "2022-01-01T09:00:00.000000Z",
      "endDate": "2021-02-01T20:30:00.000000Z",
      "createdAt": "2021-11-22T11:59:00.000000Z",
      "updatedAt": "2021-11-22T11:59:00.000000Z",
      "deletedAt": null
    }
  ],
  "eventCodes": [
    {
      "id": 1,
      "question": "Voluptatem sunt ut ut.",
      "questionGroup": "event_code",
      "questionCategoryId": null,
      "availableOptions": []
    },
    {
      "id": 2,
      "question": "Minus fugiat a nesciunt beatae.",
      "questionGroup": "event_code",
      "questionCategoryId": null,
      "availableOptions": []
    },
    {
      "id": 3,
      "question": "Voluptate vero beatae aliquid quibusdam dicta est.",
      "questionGroup": "event_code",
      "questionCategoryId": null,
      "availableOptions": [
        {
          "id": 1,
          "value": "Option 1"
        },
        {
          "id": 2,
          "value": "Option 1"
        },
        {
          "id": 3,
          "value": "Option 1"
        }
      ]
    },
    {
      "id": 4,
      "question": "Vero eos atque aut delectus quas.",
      "questionGroup": "event_code",
      "questionCategoryId": null,
      "availableOptions": []
    },
    {
      "id": 5,
      "question": "Delectus tempore id laudantium itaque.",
      "questionGroup": "event_code",
      "questionCategoryId": null,
      "availableOptions": []
    },
    {
      "id": 6,
      "question": "Labore nostrum est incidunt iusto explicabo debitis earum.",
      "questionGroup": "event_code",
      "questionCategoryId": null,
      "availableOptions": [
        {
          "id": 4,
          "value": "Option 1"
        },
        {
          "id": 5,
          "value": "Option 1"
        },
        {
          "id": 6,
          "value": "Option 1"
        }
      ]
    },
    {
      "id": 7,
      "question": "Aut autem rerum fugiat ab esse et.",
      "questionGroup": "event_code",
      "questionCategoryId": null,
      "availableOptions": [
        {
          "id": 7,
          "value": "Option 1"
        },
        {
          "id": 8,
          "value": "Option 1"
        },
        {
          "id": 9,
          "value": "Option 1"
        }
      ]
    }
  ],
  "meta": {
    "total": 100
  },
  "links": {
    "first": "http://api.willms.com/v1/customers?page=1",
    "last": "http://api.willms.com/v1/customers?page=5",
    "prev": "http://api.willms.com/v1/customers?page=2",
    "next": "http://api.willms.com/v1/customers?page=5",
    "self": "http://api.willms.com/v1/customers?page=3"
  }
}

Authorizations

ā€‹
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Headers

ā€‹
X-NU-KIOSK-MODE
boolean

This header will filter data based on if it should be visible in kiosk mode or not.

Query Parameters

ā€‹
after
integer

Returns events where event ID's are greater than this value.

ā€‹
endingBefore
string

Retrieve events that end before this date/time.Accepted formats:

  • YYYY-MM-DD HH:MM:SS e.g. 2021-01-01 00:00:00
  • YYYY-MM-DDTHH:mm:ss.SSSSSSZ e.g. 2021-01-01T00:00:00.000000Z
Date formats that do not include the timezone must be in UTC.

ā€‹
endingAfter
string

Retrieve events that end after this date/time. Accepted formats:

  • YYYY-MM-DD HH:MM:SS e.g. 2021-01-01 00:00:00
  • YYYY-MM-DDTHH:mm:ss.SSSSSSZ e.g. 2021-01-01T00:00:00.000000Z
Date formats that do not include the timezone must be in UTC.

ā€‹
startingBefore
string

Retrieve events that start before this date/time. Accepted formats:

  • YYYY-MM-DD HH:MM:SS e.g. 2021-01-01 00:00:00
  • YYYY-MM-DDTHH:mm:ss.SSSSSSZ e.g. 2021-01-01T00:00:00.000000Z
Date formats that do not include the timezone must be in UTC.

ā€‹
startingAfter
string

Retrieve events that start after this date/time. Accepted formats:

  • YYYY-MM-DD HH:MM:SS e.g. 2021-01-01 00:00:00
  • YYYY-MM-DDTHH:mm:ss.SSSSSSZ e.g. 2021-01-01T00:00:00.000000Z
Date formats that do not include the timezone must be in UTC.

ā€‹
onlyUnseatedItems
boolean

A boolean filter which hides any events that do not have unseated sale items.

ā€‹
onlyOnSale
boolean

A boolean filter which only displays events that are on-sale for the current context. On-sale is considered to be an event that is within the sale dates, before the event end date, with sale items that are available to purchase via the sales channel being used.

ā€‹
hideChildEvents
boolean

When set to true events that belong to a child company will not be returned.

ā€‹
scheduleId
integer

Filter events based on a schedule ID. Providing null, zero or an empty value will return unscheduled events only.

ā€‹
groupScheduledEvents
boolean

Group events into schedule ids with the next event following any applied filters returned as the lead event.

ā€‹
hideDemoMode
boolean

A boolean filter which removes any events from companies that are in demo mode. This is designed to be used in parent companies that have children.

ā€‹
currencyId
integer

The currency ID used for the event price ranges if included. Default value is the primary currency of the company.

ā€‹
withPriceRange
enum<string>

Includes a minPrice and maxPrice attribute according to the event page price preferences, in the requested currencyId or the primary trading currency of the company.

Available options:
true,
false
ā€‹
include
enum<string>[]

A list of related resources you wish to include in the response. Values can be a url encoded array, or comma separated string.

Available options:
eventCodes,
tagCategories,
companies,
eventSchedules,
media,
salePeriods
ā€‹
page
integer

The page you wish to retrieve events. If not specified, by default pagination is handled by offset.

ā€‹
offset
integer

The offset - e.g 10 for listing events starting with the 10th event. Offset will always take precedence over page.

ā€‹
limit
integer

The number of events to retrieve per page. The maximum (and default) is 100 per page.

ā€‹
lastUpdated
string

Date/Time for retrieving events who's associated database records (event, event settings, stream settings and teams) have been updated after the given lastUpdated time. Accepted formats:

  • YYYY-MM-DD HH:MM:SS e.g. 2021-01-01 00:00:00
  • YYYY-MM-DDTHH:mm:ss.SSSSSSZ e.g. 2021-01-01T00:00:00.000000Z
Date formats that do not include the timezone must be in UTC.

ā€‹
withTrashed
enum<string>

Controls records returned depending on their deletedAt status. This is a global flag, so will apply to all resources, including relationships such as resources returned under the included attribute.

  • true to include deleted records
  • false to exclude deleted records (or leave blank)

Available options:
true,
false
ā€‹
only
string

A list of attributes that you wish to be returned in the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. events.name,tagCategories.name. Can be used in conjunction with except providing both parameters don't reference the same resource.

ā€‹
except
string

A list of attributes that you wish to exclude from the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. events.name,tagCategories.name. Can be used in conjunction with only providing both parameters don't reference the same resource.

Response

Successful request to fetch active events.

ā€‹
companyId
integer

The ID of the currently selected company for the authenticated user.

ā€‹
companyName
string

The name of the currently selected company for the authenticated user.

ā€‹
events
object[]
ā€‹
eventCodes
object[]

Will only appear if you specify to include the eventCodes.

ā€‹
tagCategories
object[]

Will only appear if you specify to include the tagCategories.

ā€‹
companies
object[]

Will only appear if you specify to include the company.

ā€‹
eventSchedules
object[]

Will only appear if you specify to include the eventSchedules.

ā€‹
media
object
ā€‹
meta
object
ā€‹
links
object