GET /api/v1/templates/:template_id/passes
Get All Passes

Returns a JSON of the Passes for a given Template.

Examples

curl -i https://api.passdock.com/api/v1/templates/106/passes?api_token=75778a65dfdae310a107d2ef0bbd3780

curl -i https://api.passdock.com/api/v1/templates/106/passes?api_token=75778a65dfdae310a107d2ef0bbd3780&compact=true

curl -i https://api.passdock.com/api/v1/templates/106/passes?api_token=75778a65dfdae310a107d2ef0bbd3780&compact=true&page=1

Supported Formats

json

Success Response:

200 Good Request

              [
      {
        "auxiliary": [
          {
            "changeMessage": "Departure time changed to %@",
            "dateStyle": "PKDateStyleMedium",
            "key": "departure",
            "label": "DEPARTURE",
            "timeStyle": "PKDateStyleMedium",
            "value": "2012-11-12T10:12:20-08:00"
          }
        ],
        "back": [
          {
            "changeMessage": "",
            "key": "passport",
            "label": "PASSPORT",
            "value": "United States of America."
          }
        ],
        "bar": {
          "format": "PKBarcodeFormatQR",
          "message": "1350551026",
          "messageEncoding": "iso-8859-1"
        },
        "created_at": "2012-10-18T09:03:47Z",
        "custom": [
          {
            "transitType": "PKTransitTypeAir"
          }
        ],
        "family_id": 106,
        "header": [
          {
            "changeMessage": "Gate changed to %@",
            "key": "gate",
            "label": "GATE",
            "value": "56"
          }
        ],
        "id": 199,
        "download": "https://api.passdock.com/passes/199/cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9.pkpass",
        "primary": [
          {
            "changeMessage": "Departure changed in %@",
            "key": "from",
            "label": "FROM",
            "value": "NYC"
          },
          {
            "changeMessage": "Destination changed to %@",
            "key": "to",
            "label": "TO",
            "value": "SFO"
          }
        ],
        "relevance": {
          "locations": [
          ]
        },
        "secondary": [
          {
            "changeMessage": "Passenger name changed to %@",
            "key": "name",
            "label": "NAME",
            "value": "James Smith"
          }
        ],
        "serial_number": "serial-1350551026",
        "updated_at": "2012-10-18T09:15:31Z",
        "visual": {
          "backgroundColor": "rgb(237,184,61)",
          "foregroundColor": "rgb(255,255,255)",
          "labelColor": "",
          "logoText": "Passdock Airways"
        },
        "web_token": "cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9"
      }
  ]
          

OR 200 Good Request in compact mode

              [
      {
        "download": "https://api.passdock.com/passes/199/cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9.pkpass",
        "family_id": 106,
        "id": 199,
        "redeemed_at": null,
        "web_token": "cd4bf0e77e1c619ed55d78f5f2ead787b7c689f9"
      },
      {
        "download": "https://api.passdock.com/passes/200/793a4b7f81e9a7ee27746f3104d97fe0638d05c3.pkpass",
        "family_id": 106,
        "id": 200,
        "redeemed_at": null,
        "web_token": "793a4b7f81e9a7ee27746f3104d97fe0638d05c3"
      },
      {
        "download": "https://api.passdock.com/passes/201/b48c646805c50fdf04a6ffa5d187687e4f578522.pkpass",
        "family_id": 106,
        "id": 201,
        "redeemed_at": null,
        "web_token": "b48c646805c50fdf04a6ffa5d187687e4f578522"
      }
    ]
          

Errors

400 Bad Request
401 Unauthorized

Params

Param name	Description
template_id required	Template ID Value: Must be Fixnum
api_token required	Your Passdock API key Value: Must be String
compact optional	Choose to get the Pass list and not the full Pass json file Value: Must be one of: true, false.
page optional	Page of results, currently the param is optional, but will be required soon. Each page contains 50 Passes ordered date (more recents first) Value: Must be Fixnum