> ## Documentation Index > Fetch the complete documentation index at: https://docs.passlet.io/llms.txt > Use this file to discover all available pages before exploring further. # List passes > Lists passes, newest first by default, with cursor pagination. Filter by status, project, template, stored variables (`variable=key:value`, repeatable), scanner validity (`validOn`), or redemption state (`redeemed`, optionally scoped to one scan context with `redeemedContext`). Requires the `passes:read` scope on the access token. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/passes openapi: 3.1.0 info: title: Passlet API (Public) version: 0.1.0 description: >- Public integration API for Passlet — every route callable with a `plt_*` access token. Each operation lists the required access-token scope. license: name: UNLICENSED identifier: UNLICENSED servers: - url: https://api.passlet.io description: Production security: [] paths: /v1/passes: get: tags: - passes summary: List passes description: >- Lists passes, newest first by default, with cursor pagination. Filter by status, project, template, stored variables (`variable=key:value`, repeatable), scanner validity (`validOn`), or redemption state (`redeemed`, optionally scoped to one scan context with `redeemedContext`). Requires the `passes:read` scope on the access token. operationId: getV1Passes parameters: - name: limit in: query required: false schema: default: 20 type: integer minimum: 1 maximum: 100 description: Number of items per page - name: cursor in: query required: false schema: type: string minLength: 1 maxLength: 512 description: Opaque cursor returned by the previous page - name: offset in: query required: false schema: default: 0 type: integer minimum: 0 maximum: 9007199254740991 description: Deprecated offset compatibility parameter - name: status in: query required: false schema: minItems: 1 type: array items: type: string enum: - QUEUED - ISSUING - ISSUED - VOID - FAILED - EXPIRED description: Filter by one or more statuses - name: externalPassId in: query required: false schema: type: string description: Filter by external ID - name: search in: query required: false schema: type: string minLength: 1 maxLength: 255 description: Search by label, status, or external pass ID - name: projectId in: query required: false schema: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: string const: 'null' description: >- Filter by project. UUID = that project; the string "null" = uncategorised passes. - name: templateId in: query required: false schema: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: >- Filter by template — matches passes issued from any version of this template. - name: variable in: query required: false schema: minItems: 1 maxItems: 5 type: array items: type: string minLength: 3 maxLength: 2177 description: Stored-variable filter entry in `key:value` form. description: >- Repeatable `key:value` filter on stored pass variables (exact, trimmed match; value = everything after the first ":"). Same key repeated = any-of; different keys must all match. Max 5 entries. Example: variable=memberTier:gold&variable=region:EU - name: validOn in: query required: false schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- Only passes valid for scanning on this date (YYYY-MM-DD). Matches passes with a redemption window containing the date; passes that declare no windows are always valid. - name: redeemed in: query required: false schema: type: boolean description: >- Filter passes by whether they are redeemed — i.e. have an unreversed accepted scan (scoped by redeemedContext). - name: redeemedContext in: query required: false schema: type: string maxLength: 128 description: >- Scope the redeemed filter to one scan context key (e.g. an event day). Only meaningful together with redeemed. - name: sortBy in: query required: false schema: default: createdAt type: string enum: - createdAt - updatedAt - label - status - externalPassId description: Sort field - name: sortDir in: query required: false schema: default: desc type: string enum: - asc - desc description: Sort direction responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PublicListPassesResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ApiError' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/ApiError' '429': description: Rate limited content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiError' '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/ApiError' security: - bearerAuth: [] components: schemas: PublicListPassesResponse: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: items: type: array items: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Pass identifier externalPassId: type: string minLength: 1 maxLength: 255 description: External system pass ID label: type: string minLength: 1 maxLength: 255 description: Pass holder display name status: type: string enum: - QUEUED - ISSUING - ISSUED - VOID - FAILED - EXPIRED version: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 description: Optimistic locking version templateVersionId: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' description: >- Template version the pass currently renders with. Pinned at issue time; only changes via an explicit template upgrade to a newer published version of the same template. templateId: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Template identifier - type: 'null' description: Template identifier this pass was issued from projectId: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' description: Project the pass lives in variables: type: object propertyNames: type: string additionalProperties: {} description: Stored pass variables redemption: anyOf: - type: object properties: windows: minItems: 1 maxItems: 366 type: array items: type: object properties: start: type: string pattern: >- ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])T([01]\d|2[0-3]):[0-5]\d(:[0-5]\d(\.\d+)?)?(Z|[+-]([01]\d|2[0-3]):[0-5]\d)$ end: type: string pattern: >- ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])T([01]\d|2[0-3]):[0-5]\d(:[0-5]\d(\.\d+)?)?(Z|[+-]([01]\d|2[0-3]):[0-5]\d)$ maxUses: type: integer minimum: 1 maximum: 100000 additionalProperties: false maxUses: type: integer minimum: 1 maximum: 100000 perPeriod: type: object properties: unit: type: string enum: - day - week - month count: type: integer minimum: 1 maximum: 100000 timezone: type: string pattern: >- ^(?:UTC|GMT|[A-Za-z_]+\/[A-Za-z0-9_+-]+(?:\/[A-Za-z0-9_+-]+)?)$ description: IANA timezone identifier required: - unit - count - timezone additionalProperties: false minIntervalMinutes: type: integer minimum: 1 maximum: 527040 activation: type: object properties: basis: type: string const: firstScan validForHours: type: integer minimum: 1 maximum: 87840 required: - basis - validForHours additionalProperties: false additionalProperties: false - type: 'null' description: Resolved redemption policy enforced at scan time expiresAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601 timestamp - type: 'null' description: Pass expiration timestamp createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601 timestamp updatedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601 timestamp required: - id - externalPassId - label - status - version - templateVersionId - templateId - projectId - variables - redemption - expiresAt - createdAt - updatedAt additionalProperties: false total: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Total number of items limit: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Items per page offset: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Items skipped nextCursor: description: Opaque cursor for the next page, or null when exhausted anyOf: - type: string - type: 'null' hasMore: type: boolean description: Whether more items exist required: - items - total - limit - offset - hasMore additionalProperties: false ApiError: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: errorCode: type: string enum: - UNAUTHORIZED - FORBIDDEN - TOKEN_EXPIRED - TOKEN_INVALID - CSRF_TOKEN_INVALID - TENANT_EXPIRED - TENANT_NOT_FOUND - ORGANIZATION_REQUIRED - TENANT_SUSPENDED - VALIDATION_ERROR - INVALID_INPUT - MISSING_REQUIRED_FIELD - INVALID_FORMAT - NOT_FOUND - PASS_NOT_FOUND - TEMPLATE_NOT_FOUND - WEBHOOK_NOT_FOUND - NOTIFICATION_NOT_FOUND - CONFLICT - VERSION_CONFLICT - DUPLICATE_PASS - IDEMPOTENCY_CONFLICT - TEMPLATE_VERSION_NOT_NEWER - SCAN_REVERSAL_WINDOW_EXPIRED - WEBHOOK_MANAGED_EXTERNALLY - PASS_ALREADY_ISSUED - PASS_ALREADY_VOIDED - PASS_NOT_ISSUED - PASS_ISSUING_FAILED - APPLE_SIGNING_FAILED - APPLE_APNS_FAILED - GOOGLE_API_FAILED - GOOGLE_JWT_FAILED - PROVIDER_UNAVAILABLE - LINK_EXPIRED - LINK_REVOKED - LINK_INVALID - TOKEN_SIGNATURE_INVALID - TOKEN_CLOCK_SKEW - RATE_LIMITED - TOO_MANY_REQUESTS - INTERNAL_ERROR - SERVICE_UNAVAILABLE - JOB_FAILED description: Machine-readable error code message: type: string description: Human-readable error message correlationId: type: string description: Request correlation ID for debugging details: description: Additional error details type: object propertyNames: type: string additionalProperties: {} required: - errorCode - message - correlationId additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: plt_ description: >- Passlet access token (`plt_*`) sent as `Authorization: Bearer ` or `X-API-Key`. Authorized scopes are listed per operation under `x-required-scopes`. ````