PApassentry
Scans

List scans

Changed on
get/api/v1/scans

Request

  • Base URL
    https://api.passentry.com
  • URL
    https://api.passentry.com/api/v1/scans
  • Auth
    HTTP bearer

Query parameters

perPageinteger

Record limiter per page. Default is 100

entitystring

Filter by entity uuid

readerIdstring

Filter by reader uuid

passIdstring

Filter by pass uuid or ext_id

validationType'internalValidation' | 'externalValidation'

Filter by validation type

scanType'nfc' | 'barcode'

Filter by scan type

status'successful' | 'failed'

Filter by status

eventIdstring

Filter by event uuid

passTemplateNamestring

Filter by pass template name

passTemplateIdstring

Filter by pass template uuid. Use instead of passTemplateName when templates in different entities share the same name

groupTagstring

Filter by group tag

groupTags[]string[]

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

createdAfterstring

Filter by created after. Format: ISO 8601

createdBeforestring

Filter by created before. Format: ISO 8601

Response

Successful

Example response

{
  "data": [
    {
      "id": "0194a887-f880-703f-b8cf-16c1ea804b08",
      "type": "scan",
      "relationships": {
        "pass": {
          "data": {
            "id": "e89b1330fc391ec89656f3c664318cff8805471e",
            "type": "pass"
          }
        },
        "reader": {
          "data": {
            "id": "CC202952",
            "type": "reader"
          }
        }
      }
    }
  ],
  "included": [
    {
      "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"
          }
        ],
        "enhancedData": {
          "eventTicket": {
            "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"
            }
          },
          "generic": {
            "featuredActions": {
              "one": {
                "type": "viewSchedule",
                "url": "https://www.example.com/schedule"
              },
              "two": {
                "type": "viewSchedule",
                "url": "https://www.example.com/schedule"
              }
            }
          }
        }
      }
    }
  ]
}

Changes

  • 0748466491e3Revision changes
    • info

      added the optional property /////// to the response with the status

  • fc0003c277d0Revision changes
    • info

      added the optional property //////// to the response with the status