Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Passes > Pass Images

Get Pass Images Type Resolution

Retrieve all images of a specific type and resolution associated with a pass.

Parameters:

  • type: The type of images to retrieve.
  • resolution: The resolution of the images to retrieve.
  • lpass: Pass object, automatically resolved from the request.
  • temp_file: Temporary file object, automatically resolved.

Returns:

  • FileResponse: A file response containing the requested image.
get/v2/passes/{passTypeIdentifier}/{serialNumber}/images/{type}/{resolution}

Path parameters

type'logo' | 'icon' | 'strip' | 'footer' | 'background' | 'thumbnail' required

Supported images Boarding pass: logo, icon, footer Coupon: logo, icon, strip Event ticket: logo, icon, strip, background, thumbnail If you specify a strip image, do not specify a background image or a thumbnail. Generic: logo, icon, thumbnail Store card: logo, icon, strip

Args: StrEnum (type): description

resolution'normal' | 'high' | 'ultra' required
passTypeIdentifierstring nullable required
serialNumberstring nullable required

Query parameters

passIdstring
Example:5eb7cf5a86d9755df3a6c593

Headers

authorizationstring nullable

Response

Successful Response

{"stackTrail":"paths:/v2/passes/{passTypeIdentifier}/{serialNumber}/images/{type}/{resolution}:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}