CLcleeng

Get a pass [Beta]

Use this endpoint to get pass details based on pass ID.

get/passes/{passId}

Request

  • Base URL
    https://api.sandbox.cleeng.com/3.1
  • URL
    https://api.sandbox.cleeng.com/3.1/passes/{passId}
  • Auth
    API key in header X-Publisher-Token

Path parameters

passIdinteger required

Pass identifier in Cleeng.

Headers

Content-Typestring

application/json

Response

200

passIdinteger
customerIdinteger
statusstring
offerIdstring
expiresAtinteger
paymentMethodIdinteger
externalIdstring
externalPropertiesobject
isExternallyManagedboolean
sourcestring

Example response

{
  "passId": 123456789,
  "customerId": 123123123,
  "status": "active",
  "offerId": "P987654321_PL",
  "expiresAt": 1713181108,
  "paymentMethodId": 111222333,
  "externalId": "CustomerExternalId",
  "isExternallyManaged": true,
  "source": "samsung"
}

Changes

No recorded changes to this operation across all 1 revision of this API.