Skip to main content
GET
/
api
/
v1
/
passes
/
{id}
Get pass
curl --request GET \
  --url https://api.passentry.com/api/v1/passes/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.passentry.com/api/v1/passes/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.passentry.com/api/v1/passes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.passentry.com/api/v1/passes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.passentry.com/api/v1/passes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.passentry.com/api/v1/passes/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.passentry.com/api/v1/passes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "d2ac8d95-6914-4cac-957c-2a5ccf534390",
    "type": "pass",
    "attributes": {
      "downloadUrl": "https://www.example.com?pass=d2ac8d95-6914-4cac-957c-2a5ccf534390",
      "passType": "generic",
      "createdAt": "2022-01-01T00:00:00Z",
      "status": "issued",
      "extId": "b1985e420025dd92ccf2",
      "passTemplateUuid": "2e2d7ee8c306e8f0223dbdc1",
      "passTemplateName": "PassEntry Ticketing",
      "nfc": null,
      "barcode": {},
      "passContent": {
        "fullName": "John Johnson"
      }
    }
  }
}
{
  "errors": [
    "Access denied"
  ]
}
{
  "errors": [
    "Pass with provided id not found"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Pass UUID or External ID

Query Parameters

​
includePassDesign
boolean

If true, includes the pass design in the response

​
includeLocations
boolean

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

​
includeBeacons
boolean

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

​
includePassSource
enum<string>

Used when delivering the pass directly to the passholder, without using PassEntry's download page. Choose one of Apple/Google, includes the pass source in the response. The passSource object is only included if the pass is not currently 'active'

Available options:
apple,
google

Response

Successful

​
data
object