Scans
get/api/v1/scans/{id}

Request

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

Path parameters

idstring required

Scan UUID

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

    • info

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

    • info

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