v2

latestOpenAPI 3.1.02026-08-074390396.7 KB

Passes

List passes

get/api/v1/passes

Query parameters

perPageinteger

Record limiter per page. Default is 100

status'issued' | 'active' | 'removed' | 'deactivated' | 'nullified'

Filter passes by status. Accepts single status value.

status[]string[]

Filter passes by multiple statuses. Use array notation: status[]=active&status[]=issued

deviceType'android' | 'iphone'

Filter passes by device type

groupTagstring

Filter passes by group tag

groupTags[]string[]

Filter passes by multiple group tags. Use array notation: groupTags[]=tag1&groupTags[]=tag2

extIdPrefixstring

Filter passes by external ID prefix. Example: '123456' will match '123456' and '1234567890'. Case sensitive.

passTemplateUuidstring

Filter passes by pass template UUID

passTemplateNamestring

Filter passes by pass template name. Must be URL encoded

eventUuidstring

Filter passes by event UUID

eventNamestring

Filter passes by event name. Must be URL encoded

createdAfterstring

Returns passes created after given datetime. Format is ISO 8601

createdBeforestring

Returns passes created before given datetime. Format is ISO 8601. Can be combined with createdBefore parameter

fieldsstring

Returns a partial response (Sparse fieldset) per record, instead of the whole record. Set one or many comma separated record attributes

includePassDesignboolean

If true, includes the pass design in the response

includeLocationsboolean

If true, includes the locations in the response if any are present

includeBeaconsboolean

If true, includes the beacons in the response if any are present

includeBindingboolean

If true, includes the account binding data in the response for passes that have binding configured.

includeNullifiedboolean

If true, includes nullified passes in the response. By default, nullified passes are excluded from list results.

Response

Successful

Example response

{
  "data": [
    {
      "id": "e89b1330fc391ec89656f3c664318cff8805471e",
      "type": "pass",
      "attributes": {
        "barcode": {
          "value": "123abcd"
        },
        "passDesign": {
          "backgroundColor": "#EFEFEF",
          "labelColor": "#EFEFEF",
          "textColor": "#EFEFEF"
        },
        "locations": [
          {
            "name": "West Entrance",
            "latitude": 51.54321132456805,
            "longitude": -0.022901231803803924,
            "radius": 90,
            "message": "Welcome! Enjoy the show!",
            "address": "Mick's Garage, Queens Yard, London, England, E9 5EN, United Kingdom"
          }
        ],
        "beacons": [
          {
            "proximityUuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
            "major": 65535,
            "minor": 8525,
            "message": "You're near my store",
            "name": "West Entrance"
          }
        ],
        "enhancedEventData": {
          "event": {
            "name": "PassEntry Christmas Party",
            "startDateTime": "2026-12-10T18:00:00Z",
            "endDateTime": "2026-12-10T22:00:00Z"
          },
          "venue": {
            "name": "Fulham Green",
            "region": "London",
            "location": {
              "latitude": 51.468532,
              "longitude": -0.210611
            },
            "contactPhoneNumber": "+447400123456",
            "contactEmailAddress": "venue@passentry.com",
            "websiteUrl": "https://www.example.com"
          },
          "seat": {
            "number": "7",
            "row": "H",
            "section": "312",
            "gate": "26"
          },
          "eventGuide": {
            "venueOpenDateTime": "2026-12-10T17:00:00Z",
            "venueCloseDateTime": "2026-12-10T22:00:00Z"
          }
        }
      }
    }
  ]
}