{"info":{"_postman_id":"a5533aee-e3e2-41ba-a102-49cdf20ba5bd","name":"Smartix API","description":"

Smartix API functions.

Yopu will need and API key sto use these functions.

You can create API Keys in Smartix Studio (https://studio.smartix.uk)

You must create pass templates in Smartix Studio before you can create and manage passes.

Archived templates cannot be used to generate passses (but can be unarchived in Smartix Studio).

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7151620","collectionId":"a5533aee-e3e2-41ba-a102-49cdf20ba5bd","publishedId":"2sB2qWGPWf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-09-02T13:29:38.000Z"},"item":[{"name":"Passes API","item":[{"name":"Make Pass","id":"9c7681f7-d684-4e00-95a4-50eb07e690a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"},{"key":"x-mode","value":"live","type":"text"}],"body":{"mode":"raw","raw":"{\n\"loyalty.points.balance\" : 99,\n\"loyalty.points.collected\" : 600\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/makePass/:template_id","description":"

Make new pass

This endpoint is used to create pass data for a specific template and pass ID using data supplied in the request body.

Returns

URLs that can be used to install the pass on apple and gogogle devices.

The Apple and Google URLs are digitally signed, any modification will result in pass installation failure.

Request

Method: PUT
\n
URL: {{passes_url}}/makePass/:template_id/:pass_id
\n
Headers:
\n
- x-api-key : Your API key
  \n
- x-mode : Either \"live\" or \"test\". Determines whether a live or test pass wil be created. Default to \"LIVE\" if omitted.
  \n
\n
Path Parameters:
\n
- template_id (string): The ID of the template. (must match a pre-defined template)
  \n
- pass_id (string): The ID of the pass (must be unique withing the specified template_id)
  \n
\n
Body:
\n
- JSON formatted data object containing all data referenced from your specific pass template required in order to personalise your pass. Use the sampel data provided in creator as a guide as to the required content of your pass data.
  \n
- In addition, the following fixed values can be used to set specific attributes of your isssued pass.
  \n
  - grouping
    \n
    - id : (string) [Apple & Google] Several passes can be grouped together within a wallet by using a common grouping ID
      \n
    - index : (integer) [Google Only] You can speficy the order the passes appear on Google devices by using a sequential index value.
      \n
    \n
  - pass_validity [Apple & Google]
    \n
    - start : (ISO datetime string) If specified, your pass will not be shown as valid until this start date. (NOTE: Apple passes do not use this field).
    - end : (ISO datetime string) If specified, your pass will not be shown as valid after this end date.
      - NOTE: On Apple devices an expired pass is displayed with the barcode greyed out and with the serial number replaced with the text \"this pass has expired\". It is also moved to the expired passes section.
        \n
      - NOTE: On Google devices, the pass is moved to the archived pass section. NOTE: It can take up to 24 hours for a pass to be moved.
        \n
      \n
    \n
  - relevance
    \n
    - beacons : (array) [Apple Only] An object that represents the identifier of a Bluetooth Low Energy beacon the system uses to show a relevant pass
      \n
      - major : (integer) The major identifier of a Bluetooth Low Energy location beacon.
        \n
      - minor : (integer) The minor identifier of a Bluetooth Low Energy location beacon.
        \n
      - proximityUUID : (string) (Required) The unique identifier of a Bluetooth Low Energy location beacon.
        \n
      - relevantText : (string) The text to display on the lock screen when the pass is relevant. For example, a description of a nearby location, such as “Store nearby on 1st and Main”.
        \n
      \n
    - locations : (array) [Apple & Google] An object that represents a location that the system uses to show a relevant pass.
      \n
      - altitude : (double) [Apple Only] The altitude, in meters, of the location.
        \n
      - latitude : (double) (Required) The latitude, in degrees, of the location.
        \n
      - longitude : (double)(Required) The longitude, in degrees, of the location.
        \n
      - relevantText : (string) [Apple Only] The text to display on the lock screen when the pass is relevant. For example, a description of a nearby location, such as “Store nearby on 1st and Main”.
        \n
      \n
    - relevant_dates : (array) [Apple Only] An object that represents a date interval that the system uses to show a relevant pass. Either
      \n
      - date : ISO datetime string) The date and time when the pass becomes relevant. eg. \"2025-06-10T10:54:00Z\". Used for a single date.
        \n
      - OR (for a date range)
        \n
      - start : (ISO datetime string) The date and time when the pass becomes relevant eg. \"2025-06-10T10:54:00+01:00\"
        \n
      - end : (ISO datetime string) (Required) The date and time for the pass relevancy interval to end eg. \"2025-06-10T11:54:00+01:00\"
        \n
      - OR (valid from now until an end date)
        \n
      - end : (SIO datetime string) (Required) The date and time for the pass relevancy interval to endeg. \"2025-06-10T10:54:00-02:00\"
        \n
      \n
    \n
  \n
\n

Example request

{\n  \"pass\" : {\n    \"validity\" : {\n      \"start\" : \"2026-01-01T00:00:00Z\",\n      \"end\" : null\n    },\n    \"relevance\" : {},\n    \"grouping\" : {\n      \"id\" : \"my grouping name\",\n      \"index\" : 1\n    }\n  },\n  \"stamp\" : {\n    \"stamps\" : {\n      \"balance\" : 1\n    }\n  }\n}\n\n

Alternatively, you may use leaf paths instead of expanded JSON:

{\n  \"validity.start\": \"2026-01-01T00:00:00Z\",\n  \"grouping.id\": \"my grouping name\",\n  \"grouping.index\": 1,\n  \"stamp.stamps.balance\": 1\n}\n\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- appleUrl : Url to pass to customer for them to install an Apple version of the pass
  \n
- googleUrl : Url to pass to customer for them to install an Google version of the pass
  \n
- pass_id : ID of the pass
  \n
\n

Exmpale response

{\n    \"appleUrl\": \"https://api.smartix.uk/pkpass/\",\n    \"googleUrl\": \"https://pay.google.com/gp/v/save/\",\n    \"mode\": \"live\",\n    \"ok\": true,\n    \"pass_id\": \"39JH-XWF6-CGMU-QXQ4\"\n}\n\n

\n","urlObject":{"path":["makePass",":template_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"ef64d437-710a-4fd2-b213-13abcd647106","description":{"content":"

Pass Template ID

\n","type":"text/plain"},"type":"any","value":"loyalty_EDV_V1W_QNP_JHF_65F","key":"template_id"}]}},"response":[],"_postman_id":"9c7681f7-d684-4e00-95a4-50eb07e690a8"},{"name":"Make Passes","id":"cd104ded-5d19-4f80-9bdb-c1a83716fe96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

Offline key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"__grouping_id__\": \"MEM.GROUP2\",\n \"passes\": [\n {\n \"template_id\": \"smartix_membership_EKP_L31_RAB_MPA_BNY\",\n \"pass_id\": \"MEM-TEST-12\",\n \"instance_data\": {\n \"test1\" : 1\n },\n \"scanner_instance_data\": {\n \"test2\": 2\n }\n },\n {\n \"template_id\": \"smartix_membership_EKP_L31_RAB_MPA_BNY\",\n \"pass_id\": \"MEM-TEST-13\",\n \"instance_data\": {\n \"test3\" : 3\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/makePasses","description":"

Make new passes (group)

This function is used to create a group of passes which will be displayed as a group in the user's wallet. You can supply a grouping id, or allow Smartix to generate one for you. If you specify your own grouping id it can be easier to add futher passes to that group later.

Returns

URLs that can be used to install the pass on apple and gogogle devices.

The Apple and Google URLs are digitally signed, any modification will result in pass installation failure.

Request

Method: POST
\n
URL: https://api.smartix.uk/passes-0101/makePasses/:template_id/:pass_id
\n
Headers:
\n
- x-api-key : Your API key
  \n
- x-mode : Either \"live\" or \"test\". Determines whether a live or test passes wil be created. Default to \"LIVE\" if omitted.
  \n
\n
Path Parameters:
\n
- template_id (string): The ID of the template. (must match a pre-defined template)
  \n
- pass_id (string): The ID of the pass (must be unique withing the specified template_id)
  \n
\n

Body: An array of pass data. See Make Pass for data format.

Example request

{\n    \"passes\": [\n        {\n            \"template_id\": \"loyalty_GHL_5K8_YAP_DNX_PNT\",\n            \"pass_id\": \"LOYALTY_GROUP_11\",\n            \"data\": {\n                \"grouping\": {\n                    \"id\": \"LOYALTY.GROUP\",\n                    \"index\": 1\n                }\n            }\n        },\n        {\n            \"template_id\": \"loyalty_GHL_5K8_YAP_DNX_PNT\",\n            \"pass_id\": \"LOYALTY_GROUP_12\",\n            \"data\": {\n                \"grouping\": {\n                    \"id\": \"LOYALTY.GROUP\",\n                    \"index\": 2\n                }\n            }\n        }\n    ]\n}\n\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- appleGroupedUrl : This link will install the whole group of Apple passes
  \n
- appleUrls : Individual URLs for each Apple passes
  \n
- googleUrl : This link will install the whole group of Google passes
  \n
\n

Example response

{\n    \"appleGroupedUrl\": \"https://api.smartix.uk/pkpasses/\",\n    \"appleUrls\": [\n        \"https://api.smartix.uk/pkpass/\",\n        \"https://api.smartix.uk/pkpass/\"\n    ],\n    \"googleUrl\": \"https://pay.google.com/gp/v/save/\",\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["makePasses"],"host":["{{passes_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd104ded-5d19-4f80-9bdb-c1a83716fe96"},{"name":"Get Pass","id":"7c0aa15b-cb78-4554-8955-7ca8f29de095","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/getPass/:pass_id","description":"

Get pass

This endpoint is used to retrieve data relating to an issued pass.

Returns

Pass instance data, count of Apple and Google device installations, Apple pass URL, Google pass URL, timestamps)

Request

Method: GET
\n
URL:{{passes_url}}/:template_id/:pass_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- template_id (string): The ID of the template.
  \n
- pass_id (string): The ID of the pass.
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- pass
  \n
  - client_id : your client ID
    \n
  - user_id : ID of the user/API Key that created this pass
    \n
  - template_id : (string) Pass template ID
    \n
  - pass_id : (string) Pass ID
    \n
  - mode : (string) : Either \"live\" or \"test\"
    \n
  - grouping_id : A unique ID used to group multiple passes together in a wallet
    \n
  - grouping_index : Order of passes in the group (Google only)
    \n
  - creation_timestamp : (ISO datetime string) Date and time pass created
    \n
  - last_modified_apple_timestamp : (ISO datetime string) Date and time Apple version last modified
    \n
  - last_modified_google_timestamp : (ISO datetime string) Date and time Google version last modified
    \n
  - expiry_date : (ISO datetime string) Date and time pass wil expiry (no expiry is null).
    \n
  - apple_url : (string) URL to install Apple pass
    \n
  - google_url : (string) URL to install Google pass
    \n
  - apple_installs : (integer) Number of Apple devices pass is currently installed on
    \n
  - google_installs : (integer) Number of Google devices pass is currently installed on
    \n
  - variables : (object) Your unique pass data
    \n
  - scanner_data : (object) Data managed by Smartix Scan *
    \n
  - scanner_audit_data : (array) Record of scans made by Smartix Scan **
    \n
  \n
\n

Example response

{\n    \"ok\": true,\n    \"pass\": {\n        \"apple_installs\": 0,\n        \"apple_sync_hash\": null,\n        \"apple_url\": \"https://api.smartix.uk/pkpass/\",\n        \"charge_applied\": 1,\n        \"client_id\": 0,\n        \"creation_timestamp\": \"20260528135725\",\n        \"expiry_date\": null,\n        \"google_installs\": 0,\n        \"google_object_sync_hash\": \"3e9d75865d08c2205441ff9d53685aa6e61234dee67b3e375cc148eb31e43cb9\",\n        \"google_url\": \"https://pay.google.com/gp/v/save/\",\n        \"grouping_id\": null,\n        \"grouping_index\": null,\n        \"has_smartix_advert\": 0,\n        \"key_id\": 1,\n        \"key_type\": \"key\",\n        \"last_modified_apple_timestamp\": \"20260528135725\",\n        \"last_modified_google_timestamp\": \"20260528135725\",\n        \"mode\": \"live\",\n        \"pass_id\": \"39JH-XWF6-CGMU-QXQ4\",\n        \"scanner_audit_data_enc\": [],\n        \"template_id\": \"offer\",\n        \"update_counter\": 0,\n        \"variables\": {\n            \"event\": {\n                \"ticket\": {\n                    \"scanned\": false,\n                    \"scanned_datetime\": \"20260101000000\"\n                }\n            },\n            \"pass\": {\n                \"pass_id\": \"39JH-XWF6-CGMU-QXQ4\"\n            },\n            \"scan\": {\n                \"disabled\": false,\n                \"disabled_date\": \"20260101000000\",\n                \"note\": \"no note\"\n            }\n        }\n    }\n}\n\n

* Smartix Scan data

These fields are only present for managed passes. scanner_instance_data contains scan related data, get number of loyalty points, number of scans, goft card balance etc. scanner_audit_data is a record of any changes made to scanner_instance_data by Smartix Scan or within Smartix Studio.

\n","urlObject":{"path":["getPass",":pass_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"264e7ba2-f28b-496a-92cb-d1252649e3c2","type":"any","value":"ACRC-S6PC-SQHR-2ZJC","key":"pass_id"}]}},"response":[],"_postman_id":"7c0aa15b-cb78-4554-8955-7ca8f29de095"},{"name":"Add loyalty points","id":"ec59ed5a-de47-4383-890b-cab79b352325","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/managed/loyalty/add/:pass_id /:num_points","description":"

Add managed pass loyalty points

This endpoint is used to add points to a managed loyalty card.

Returns

The new points balance.

Request

Method: PUT
\n
URL: {{passes_url}}/managed/loyalty/add/:pass_id/:num_points
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
  \n
- num_points (integer) : The number of points to add
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- points (integer) : new points balance
  \n
\n

{\n    \"ok\": true,\n    \"points\": 29896\n}\n\n

\n","urlObject":{"path":["managed","loyalty","add",":pass_id ",":num_points"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"5f3424d6-3d97-40a1-bed1-ba5f30f033be","type":"any","value":"RV69-DL9P-PAFM-FAUG","key":"pass_id "},{"id":"0e46967e-b090-476c-b357-e25ab14da3ed","type":"any","value":"12","key":"num_points"}]}},"response":[],"_postman_id":"ec59ed5a-de47-4383-890b-cab79b352325"},{"name":"Remove loyalty points","id":"ee2490a0-e9dd-40dc-89ca-baa35456fa3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/managed/loyalty/remove/:pass_id /:num_points","description":"

Remove managed pass loyalty points

This endpoint is used to remove points from a managed loyalty card.

This should be used for admin purposes. if customer is redeemign points, use Redeem Loyalty Points function intsead.

Returns

The new points balance.

Request

Method: PUT
\n
URL: {{passes_url}}/managed/loyalty/remove/:pass_id/:num_points
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
  \n
- num_points (integer) : The number of points to remove
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- points (integer) : new points balance
  \n
\n

{\n    \"ok\": true,\n    \"points\": 29896\n}\n\n

\n","urlObject":{"path":["managed","loyalty","remove",":pass_id ",":num_points"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"e0862423-5b23-4745-9cc4-ec70e06d674e","type":"any","value":"RV69-DL9P-PAFM-FAUG","key":"pass_id "},{"id":"85aac4ef-fcd7-420d-a490-0a9d571be6c9","type":"any","value":"61","key":"num_points"}]}},"response":[],"_postman_id":"ee2490a0-e9dd-40dc-89ca-baa35456fa3d"},{"name":"Add stampcard stamps","id":"8a9a1f60-140a-4915-b740-265d1020fd55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/managed/stamp/add/:template_id/:pass_id /:num_stamps","description":"

Add managed pass stampcard stamps

This endpoint is used to add stamps to a managed stampcard card.

Returns

The new stamps and full card balances.

Request

Method: PUT
\n
URL: {{passes_url}}/managed/stamp/add/:pass_id/:num_stamps
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- template_id (string): The ID of the template.
  \n
- pass_id (string): The ID of the pass.
  \n
- num_stamps (integer) : The number of stamps to add
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- stamps (integer) : new stamps balance
  \n
- cards (integer) : new full cards balance
  \n
\n

{\n    \"cards\": 187,\n    \"ok\": true,\n    \"stamps\": 1872\n}\n\n

\n","urlObject":{"path":["managed","stamp","add",":template_id",":pass_id ",":num_stamps"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"9e3f6ef0-fa03-4360-9f8b-f015e487ab9c","type":"any","value":"stamp_J5W_7PU_QGF_FAB_KX9","key":"template_id"},{"id":"b92d066a-8ce9-4be6-ada6-2fee3ba74773","type":"any","value":"CGW3-TUSE-GUS4-KZKL","key":"pass_id "},{"id":"6dbc738b-63d2-49d1-ad32-922e0a5223eb","type":"any","value":"45","key":"num_stamps"}]}},"response":[],"_postman_id":"8a9a1f60-140a-4915-b740-265d1020fd55"},{"name":"Remove stampcard stamps","id":"5085a702-913c-4ba9-b6d2-ca46fa987ffe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/managed/stamp/remove/:pass_id /:num_stamps","description":"

Remove managed pass stampcard stamps

This endpoint is used to remove stamps from a managed stampcard card. When redeemign cards, use Redeem Stampcards instead. Thsi functions is for removing stamps for other reasons.

Returns

The new stamps and full card balances.

Request

Method: PUT
\n
URL: {{passes_url}}/managed/stamp/remove/:pass_id/:num_stamps
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
  \n
- num_stamps (integer) : The number of stamps to remove
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- stamps (integer) : new stamps balance
  \n
- cards (integer) : new full cards balance
  \n
\n

{\n    \"cards\": 187,\n    \"ok\": true,\n    \"stamps\": 1872\n}\n\n

\n","urlObject":{"path":["managed","stamp","remove",":pass_id ",":num_stamps"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"64d37b95-1ffb-489e-8408-2477e19d80d5","type":"any","value":"CGW3-TUSE-GUS4-KZKL","key":"pass_id "},{"id":"23405ea1-dcb1-44b0-a8b7-4dc6f1cc14c7","type":"any","value":"61","key":"num_stamps"}]}},"response":[],"_postman_id":"5085a702-913c-4ba9-b6d2-ca46fa987ffe"},{"name":"Redeem stampcards","id":"806389de-93e3-4c2c-88f0-ade64635fbf4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/managed/stamp/redeem/:pass_id /:num_cards","description":"

Redeem Stampcards

This endpoint is used to redeemfull full managed stampcard cards.

Returns

The new stamps and full card balances.

Request

Method: PUT
\n
URL: {{passes_url}}/managed/stamp/redeem/:pass_id/:num_cards
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
  \n
- num_cards (integer) : The number of cards to redeem
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- stamps (integer) : new stamps balance
  \n
- cards (integer) : new full cards balance
  \n
\n

{\n    \"cards\": 187,\n    \"ok\": true,\n    \"stamps\": 1872\n}\n\n

\n","urlObject":{"path":["managed","stamp","redeem",":pass_id ",":num_cards"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"526c5de8-9c6d-4c60-8f94-e05b5555886c","type":"any","value":"CGW3-TUSE-GUS4-KZKL","key":"pass_id "},{"id":"e6845f4a-22e1-42fa-b23d-04a57513c62b","type":"any","value":"1","key":"num_cards"}]}},"response":[],"_postman_id":"806389de-93e3-4c2c-88f0-ade64635fbf4"},{"name":"Redeem gift card","id":"c99f4b8d-503a-42af-b236-aad9cdd74e6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/managed/gift/redeem/:pass_id /:amount","description":"

Redeem Gift card

This endpoint is used to debit the balance of a managed gift card.

Returns

The new stamps and full card balances.

Request

Method: PUT
\n
URL: {{passes_url}}/managed/gift/redeem/:pass_id/:amount
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
  \n
- amount (money string) : The amount to debit
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- balance (money) : new balance
  \n
\n

{\n    \"balance\": \"25.00\",\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["managed","gift","redeem",":pass_id ",":amount"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"26b90530-8f39-4802-bf1d-533a643f5c25","type":"any","value":"FMPW-R3PS-KZLS-4SCC","key":"pass_id "},{"id":"b0d56312-4eb4-4e0e-8f5b-1c1a0d48f135","type":"any","value":"1.50","key":"amount"}]}},"response":[],"_postman_id":"c99f4b8d-503a-42af-b236-aad9cdd74e6f"},{"name":"Refund gift card","id":"8f2c840e-04a9-4942-96e2-c668ffd0a8c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/managed/gift/refund/:pass_id /:amount","description":"

Refund Gift card

This endpoint is used to refund to the balance of a managed gift card.

Returns

The new stamps and full card balances.

Request

Method: PUT
\n
URL: {{passes_url}}/managed/stamp/add/:pass_id/:amount
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
  \n
- amount (money string) : The amount to refund
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- balance (money) : new balance
  \n
\n

{\n    \"balance\": \"25.00\",\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["managed","gift","refund",":pass_id ",":amount"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"16ae02b7-70ff-47e4-bcda-b90a6a619528","type":"any","value":"FMPW-R3PS-KZLS-4SCC","key":"pass_id "},{"id":"9df1c991-ca3f-4010-82cd-38f9b89b249c","type":"any","value":"12.57","key":"amount"}]}},"response":[],"_postman_id":"8f2c840e-04a9-4942-96e2-c668ffd0a8c5"},{"name":"Redeem loyalty points","id":"a66d8f40-70f9-4fb1-a2f2-d7e9902bc87e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/managed/loyalty/redeem/:pass_id /:num_points","description":"

Redeem managed pass loyalty points

This endpoint is used to remove points from a managed loyalty card.

This should be used when customer is redeemign points. If you wish to remove points for another reaosn, pelase use Removel Lotalty Points funciton instead.

Returns

The new points balance.

Request

Method: PUT
\n
URL: {{passes_url}}/managed/loyalty/redeem/:pass_id/:num_points
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
  \n
- num_points (integer) : The number of points to remove
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- points (integer) : new points balance
  \n
\n

{\n    \"ok\": true,\n    \"points\": 29896\n}\n\n

\n","urlObject":{"path":["managed","loyalty","redeem",":pass_id ",":num_points"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"046ef846-4bc7-4345-a3a8-a9ad5eff28f7","type":"any","value":"RV69-DL9P-PAFM-FAUG","key":"pass_id "},{"id":"dc4c2003-e91e-43be-8ddd-183f68742607","type":"any","value":"12","key":"num_points"}]}},"response":[],"_postman_id":"a66d8f40-70f9-4fb1-a2f2-d7e9902bc87e"},{"name":"Set managed pass status","id":"4be6b92c-214d-4d1b-812d-ade77617e967","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"note\" : \"A test note\"\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/managed/status/:pass_id/:enabled","description":"

Set managed pass (enabled) status

This endpoint is used to disable/enable a managed pass.

Returns

The new status

Request

Method: PUT
\n
URL: {{passes_url}}/managed/status/:template_id/:pass_id/:enabled
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
  \n
- enabled (boolean) : enable the card? (false = disable)
  \n
\n
Body
\n
- note (string) : the note to add to the pass
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- status (string) : new status (enabled or disabled)
  \n
\n

{\n    \"ok\": true,\n    \"status\": \"disabled\"\n}\n\n

\n","urlObject":{"path":["managed","status",":pass_id",":enabled"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"988e981e-5fd2-4040-87dd-f1b06d4dfe39","type":"any","value":"8P2-QPD-6V5","key":"pass_id"},{"id":"94586abc-cf5b-44a1-abca-9ca13dd62896","type":"any","value":"false","key":"enabled"}]}},"response":[],"_postman_id":"4be6b92c-214d-4d1b-812d-ade77617e967"},{"name":"Set managed pass note","id":"80bc12a0-7acf-4258-a5a2-e58d06b026f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"note\" : \"A new note\"\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/managed/note/:pass_id ","description":"

Set managed pass note

This endpoint is used to add a note to a managed pass.

Notes are visible in Smartix Scan.

Returns

The new status

Request

Method: PUT
\n
URL: {{passes_url}}/managed/status/:pass_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
\n
Body :
\n
- note (string) : the not to attched to the pass
\n

Example request

{\n    \"note\" : \"A new note\"\n}\n\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- status (string) : new status (enabled or disabled)
  \n
\n

{\n    \"ok\": true,\n    \"status\": \"disabled\"\n}\n\n

\n","urlObject":{"path":["managed","note",":pass_id "],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"5c8b7d85-06af-47cd-a9cf-8c67a04c8c3b","type":"any","value":"8P2-QPD-6V5","key":"pass_id "}]}},"response":[],"_postman_id":"80bc12a0-7acf-4258-a5a2-e58d06b026f4"},{"name":"get Managed loyalty card data","id":"1e4bb6da-aeff-4faa-9fcf-301d522d9351","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/managed/loyalty/data/:pass_id ","description":"

Get managed loyalty card data

This endpoint is used to retrive the loyalty data for a pass. This differs from getPass in that only the data associated with the loyalty account is returned, rather than all pass data.

Returns

The loyalty, scan and history data.

Request

Method: GET
\n
URL: {{passes_url}}/managed/loyalty/data/:pass_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- loyalty (object) :
  \n
  - history (object) :
    \n
    - collection (array) :
      \n
    - redemption (array) :
      \n
    - other (array) :
      \n
    \n
  \n
- points (object) :
  \n
  - balance (integer) : current points balance
    \n
  - collected (integer) : total number of points collected
    \n
  - redeemed (integer) : number of points redeemed.
    \n
  \n
- scan (object) :
  \n
  - disabled (boolean) : indicates if pass has been disabled
    \n
  - disabled_date (ISO datetime string) : if disabled, contains the date /time it was disabled
    \n
  - note (string) : Note attached to pass
    \n
  \n
\n

Example response

{\n    \"loyalty\": {\n        \"history\": {\n            \"collection\": [\n                {\n                    \"action\": \"collect\",\n                    \"key_id\": 3,\n                    \"points_added\": 12,\n                    \"reference\": \"ABC16\",\n                    \"timestamp\": \"20260427104716\",\n                    \"username\": \"shop loyalty cards\"\n                },\n                {\n                    \"action\": \"collect\",\n                    \"key_id\": 3,\n                    \"points_added\": 12,\n                    \"reference\": \"ABC15\",\n                    \"timestamp\": \"20260421124322\",\n                    \"username\": \"shop loyalty cards\"\n                }\n            ],\n            \"other\": [],\n            \"redemption\": [\n                {\n                    \"action\": \"redeem\",\n                    \"key_id\": 3,\n                    \"points_redeemed\": 12,\n                    \"reference\": \"ABC11\",\n                    \"timestamp\": \"20260420163708\",\n                    \"username\": \"shop loyalty cards\"\n                },\n                {\n                    \"action\": \"redeem\",\n                    \"key_id\": 3,\n                    \"points_redeemed\": 12,\n                    \"reference\": \"ABC10\",\n                    \"timestamp\": \"20260420162424\",\n                    \"username\": \"shop loyalty cards\"\n                }\n            ]\n        },\n        \"points\": {\n            \"balance\": 36,\n            \"collected\": 36,\n            \"redeemed\": 0\n        },\n        \"scan\": {\n            \"disabled\": true,\n            \"disabled_date\": \"20260528163004\",\n            \"note\": \"A new note\"\n        }\n    },\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["managed","loyalty","data",":pass_id "],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"40865a49-e5c0-4d37-b319-6da0ff556709","type":"any","value":"8P2-QPD-6V5","key":"pass_id "}]}},"response":[],"_postman_id":"1e4bb6da-aeff-4faa-9fcf-301d522d9351"},{"name":"get Managed stampcard data","id":"04a82978-8649-4749-bac3-0d13b6c6eed7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/managed/stamp/data/:pass_id ","description":"

Get managed stamp card data

This endpoint is used to retrive the stampcard data for a pass. This differs from getPass in that only the data associated with the stampcard account is returned, rather than all pass data.

Returns

The stamps, cards, scan and history data.

Request

Method: GET
\n
URL: {{passes_url}}/managed/stamp/data/:pass_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- stamp (object) :
  \n
  - history (object) :
    \n
    - collection (array) :
      \n
    - redemption (array) :
      \n
    - other (array) :
      \n
    \n
  \n
- stamps (object) :
  \n
  - balance (integer) : current points balance
    \n
  - collected (integer) : total number of points collected
    \n
  \n
- caerds (object) :
  \n
  - balance (integer) : current full cards balance
    \n
  - collected (integer) : total cards filled
    \n
  - redeemed (integer) : number of full cards redeemed
    \n
  \n
- scan (object) :
  \n
  - disabled (boolean) : indicates if pass has been disabled
    \n
  - disabled_date (ISO datetime string) : if disabled, contains the date /time it was disabled
    \n
  - note (string) : Note attached to pass
    \n
  \n
\n

Example response

{\n    \"ok\": true,\n    \"stamp\": {\n        \"cards\": {\n            \"balance\": 187,\n            \"collected\": 6,\n            \"redeemed\": 15\n        },\n        \"history\": {\n            \"collection\": [\n                {\n                    \"action\": \"collect\",\n                    \"key_id\": 3,\n                    \"position\": null,\n                    \"reference\": null,\n                    \"stamps\": 45,\n                    \"timestamp\": \"20260528141732\",\n                    \"user_id\": null,\n                    \"username\": \"shop loyalty cards\"\n                },\n                {\n                    \"action\": \"collect\",\n                    \"key_id\": 1,\n                    \"position\": null,\n                    \"reference\": null,\n                    \"stamps\": 10,\n                    \"timestamp\": \"20260527103816\",\n                    \"user_id\": 1,\n                    \"username\": \"ian (bale)\"\n                }\n            ],\n            \"redemption\":[],\n            \"other\" : []\n        },\n        \"scan\": {\n            \"disabled\": false,\n            \"disabledDate\": null,\n            \"note\": null\n        },\n        \"stamps\": {\n            \"balance\": 2,\n            \"collected\": 2302\n        }\n    }\n}\n\n

\n","urlObject":{"path":["managed","stamp","data",":pass_id "],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"75460d00-0e5b-4732-bafc-984727086524","type":"any","value":"CGW3-TUSE-GUS4-KZKL","key":"pass_id "}]}},"response":[],"_postman_id":"04a82978-8649-4749-bac3-0d13b6c6eed7"},{"name":"get Managed gift card data","id":"3812fd0e-24e0-4c73-8604-54e556932d87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/managed/gift/data/:pass_id ","description":"

Get managed gift card data

This endpoint is used to retrive the stampcard data for a pass. This differs from getPass in that only the data associated with the gift card is returned, rather than all pass data.

Returns

The gift, scan and history data.

Request

Method: GET
\n
URL: {{passes_url}}/managed/gift/data/:pass_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- stamp (object) :
  \n
  - history (object) :
    \n
    - collection (array) :
      \n
    - redemption (array) :
      \n
    - other (array) :
      \n
    \n
  \n
- gift (object) :
  \n
  - balance (integer) : current points balance
    \n
  - collected (integer) : total number of points collected
    \n
  \n
\n

Example response

{\n    \"gift\": {\n        \"balance\": \"26.07\",\n        \"card_number\": \"5344-8931-3418-3266\",\n        \"gifted_amount\": 25,\n        \"history\": {\n            \"redemption\": [\n                {\n                    \"action\": \"debit\",\n                    \"amount_debited\": \"1.50\",\n                    \"key_id\": 3,\n                    \"position\": null,\n                    \"reference\": null,\n                    \"timestamp\": \"20260601101026\",\n                    \"user_id\": null,\n                    \"username\": \"shop loyalty cards\"\n                },\n                {\n                    \"action\": \"refund\",\n                    \"amount_credited\": \"12.57\",\n                    \"key_id\": 3,\n                    \"position\": null,\n                    \"reference\": null,\n                    \"timestamp\": \"20260601101006\",\n                    \"user_id\": null,\n                    \"username\": \"shop loyalty cards\"\n                }\n            ]\n        }\n    },\n    \"ok\": true,\n    \"scan\": {\n        \"disabled\": false,\n        \"disabled_date\": null,\n        \"note\": null\n    }\n}\n\n

\n","urlObject":{"path":["managed","gift","data",":pass_id "],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"daa149c6-cf0b-4960-990c-0534981839fd","type":"any","value":"FMPW-R3PS-KZLS-4SCC","key":"pass_id "}]}},"response":[],"_postman_id":"3812fd0e-24e0-4c73-8604-54e556932d87"},{"name":"get Managed membership card data","id":"5ccdc1eb-6532-4d5c-9e7e-be165424e257","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/managed/membership/data/:pass_id ","description":"

Get managed membership card data

This endpoint is used to retrive the membership data for a pass. This differs from getPass in that only the data associated with the membership is returned, rather than all pass data.

Returns

The event, scan and history data.

Request

Method: GET
\n
URL: {{passes_url}}/managed/membership/data/:pass_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- stamp (object) :
  \n
  - history (object) :
    \n
    - collection (array) :
      \n
    - redemption (array) :
      \n
    - other (array) :
      \n
    \n
  \n
- membership (object) :
  \n
  - expiry_date (ISO datetime string) : date of membershiip expiry (or null)
    \n
  - member_name (string) : member's name (optiona)
    \n
  - membership_number (string) : member's membership number (optional)
    \n
  - tier (string) : membership tier (optional)
    \n
  - discount _percentage (number) : discount given to member (optional)
    \n
  \n
\n

Example response

{\n    \"membership\": {\n        \"expiry_date\": \"20250606000000\",\n        \"member_name\": \"Jake Dumphries\",\n        \"membership_number\": \"JD56123\",\n        \"tier\": \"White\"\n    },\n    \"ok\": true,\n    \"scan\": {\n        \"disabled\": false,\n        \"disabled_date\": null,\n        \"note\": \"\"\n    }\n}\n\n

\n","urlObject":{"path":["managed","membership","data",":pass_id "],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"42a681b2-abba-4284-92c8-5a2aa17cf039","type":"any","value":"TP8U-EHVJ-RCME","key":"pass_id "}]}},"response":[],"_postman_id":"5ccdc1eb-6532-4d5c-9e7e-be165424e257"},{"name":"get installed pass report","id":"a880b464-bbcc-4c5c-b223-ec4c06fa0168","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/getTemplatePassInstallReport/:template_id","description":"

Get installed pass report

This endpoint is used to rretrieve a report of installations of passes for a given template onto user's devices.

Returns

A signed S3 URL from where the generated JSON export can be downloaded. The link is valid for 7 days.

Request

Method: GET
\n
URL: {{passes_url}}/getTemplatePassInstallReport/:template_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- template_id (string): The ID of the template.
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- pass_type_id (string) : Pass type
  \n
- rowCount (intenger) : number of passes present in the export
  \n
- s3_bucket (string) : S3 bucket name
  \n
- s3_key (string) : S3 file key
  \n
- template_id (string) : template ID of the exported data
  \n
\n

Example response

{\n    \"download_url\": \"https://s3.eu-west-1.amazonaws.com/exports.smartix.uk/template-pass-install-reports/2/smartix_loyalty_N1B_E5M_D2B_2GD_DBT/20260814105308-0f0e291a-8cbf-4a93-add1-f44f84334250.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=/20260814/eu-west-1/s3/aws4_request&X-Amz-Date=20260814T095308Z&X-Amz-Expires=604800&X-Amz-Signature=3bbe17d2dec69d62b5b9ad4886ef57e799e645b265deee22630b7970c454bdf8&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject\",\n    \"export_timestamp\": \"20260814105308\",\n    \"ok\": true,\n    \"rowCount\": 18,\n    \"s3_bucket\": \"exports.smartix.uk\",\n    \"s3_key\": \"template-pass-install-reports/2/smartix_loyalty_N1B_E5M_D2B_2GD_DBT/20260814105308-0f0e291a-8cbf-4a93-add1-f44f84334250.json\",\n    \"template_id\": \"smartix_loyalty_N1B_E5M_D2B_2GD_DBT\"\n}\n\n

\n","urlObject":{"path":["getTemplatePassInstallReport",":template_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"9ef13458-fc5a-46cf-8c62-6fc71ded65b0","type":"any","value":"smartix_loyalty_N1B_E5M_D2B_2GD_DBT","key":"template_id"}]}},"response":[],"_postman_id":"a880b464-bbcc-4c5c-b223-ec4c06fa0168"},{"name":"get Managed Pass Data report","id":"b84e7845-030e-40eb-b79d-71426f8148a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/managed/data-export/:template_id","description":"

Get managed pass data

This endpoint is used to retrive the managed pass data for all passes for a given template. This is a bulk export, so you are limited to one call per hour per template.

eg. For a gift card, we will export the current balance, gifted amount and audit history.

Returns

A signed S3 URL from where the generated JSON export can be downloaded. The link is valid for 7 days.

Request

Method: GET
\n
URL: {{passes_url}}/managed/export-data/:template_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- template_id (string): The ID of the template.
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- ok (boolean) : execution status
  \n
- pass_type_id (string) : Pass type
  \n
- rowCount (intenger) : number of passes present in the export
  \n
- s3_bucket (string) : S3 bucket name
  \n
- s3_key (string) : S3 file key
  \n
- template_id (string) : template ID of the exported data
  \n
\n

Example response

{\n    \"download_url\": \"https://s3.eu-west-1.amazonaws.com/exports.smartix.uk/managed-pass-exports/2/smartix_loyalty_N1B_E5M_D2B_2GD_DBT/20260814104348-86190166-c106-4739-b532-2d7e33748d3e.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=/20260814/eu-west-1/s3/aws4_request&X-Amz-Date=20260814T094350Z&X-Amz-Expires=604800&X-Amz-Signature=7a7e4d579c57732a1e70445f31a7959f5036e6efb17e8c6220a0bdd2ac79101d&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject\",\n    \"ok\": true,\n    \"pass_type_id\": \"managed_loyalty\",\n    \"rowCount\": 18,\n    \"s3_bucket\": \"exports.smartix.uk\",\n    \"s3_key\": \"managed-pass-exports/2/smartix_loyalty_N1B_E5M_D2B_2GD_DBT/20260814104348-86190166-c106-4739-b532-2d7e33748d3e.json\",\n    \"template_id\": \"smartix_loyalty_N1B_E5M_D2B_2GD_DBT\"\n}\n\n

\n","urlObject":{"path":["managed","data-export",":template_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"6da73489-60d8-49b3-a551-204e9c18fbec","type":"any","value":"smartix_loyalty_N1B_E5M_D2B_2GD_DBT","key":"template_id"}]}},"response":[],"_postman_id":"b84e7845-030e-40eb-b79d-71426f8148a6"},{"name":"Get Template Variables","id":"8c7140db-9b45-41dd-8226-e0c76adeea6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/getTemplateVariables/:template_id","description":"

Get template variables

This endpoint is used to retrieve template (default pass) variables

Returns

A variables object

Request

Method: GET
\n
URL:{passes_url}/getTemplateVariables/:template_id
\n
Headers:
\n
- x-api-key : Your API key
\n
URL parameters
\n
- template_id (string) : Template ID
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- variables (object) : Typical content:
  \n
  - barcode (object) :
    \n
    - format (string) : Barcode format (QR_CODE, AZTEC, PDF_417 or CODE_128)
      \n
    - payload (string) : Barcode payload
      \n
    - text (string) : Text that sites below barcode. Often pass_id.
      \n
    \n
  - colours (object) :
    \n
    - background (hex colour) :
      \n
    - foreground (hex colour) :
      \n
    - label (hex colour) :
      \n
    - strip (hex colour) :
      \n
    \n
  - images (object) :
    \n
    - apple (object) :
      \n
      - icon (string) : URL of Apple icon image (required)
        \n
      - logo (string) : URL of Apple logo image (required)
        \n
      - thumbnail (string): URL of Apple thumbnail image (optional)
        \n
      - strip (string): URL of Apple strip image (optional)
        \n
      - backgriund (string): URL of Apple background image (optional)
        \n
      \n
    - google (object) :
      \n
      - logo (string) : URL of Google logo image (required)
        \n
      - wide_logo (string) : URL of Google wide_logo image (optional)
        \n
      - hero (string) : URL of Google hero image (optional)
        \n
      \n
    - pass (object) :
      \n
      - pass_id (string) : Pass unique ID (required - readonly)
        \n
      - header (string) : header text
        \n
      - subheader (string) : subheader text (optional)
        \n
      - issuer_name (string) : pass issuer
        \n
      - title (string) : pass title text
        \n
      - grouping (object) :
        \n
        \n
        id (string) : grouoing identifier
        \n
        \n
        index (integer) : grouping order
        \n
        \n
        \n
      \n
    - scan (object) : (required for managed passes)
      \n
      - disabled (boolean) : indicated if pass has been disabled
        \n
      - disabled_date_time (ISO datetime string) : if disabled, the date/time it was disabled
        \n
      - note (string) : Note attached to the pass
        \n
      \n
    \n
  \n
\n

NOTE: variables can reference other variables using {{var name}} syntax. eg. in the example below, barcode.text = {{pass.pass_id}} which means use the value from pass.pass_id as the barcode text.

Example response

{\n    \"ok\": true,\n    \"variables\": {\n        \"barcode\": {\n            \"format\": \"QR_CODE\",\n            \"payload\": \"1.A.000-000-000-000\",\n            \"text\": \"{{pass.pass_id}}\"\n        },\n        \"colours\": {\n            \"background\": \"#ffffff\",\n            \"foreground\": \"#000000\",\n            \"label\": \"#3d3d3d\",\n            \"strip\": \"#ffffff\"\n        },\n        \"images\": {\n            \"apple\": {\n                \"icon\": \"https://s3.eu-west-1.amazonaws.com/images.smartix.uk/2/apple/icon/C-20260209120645-20260210091007.png\",\n                \"logo\": \"https://s3.eu-west-1.amazonaws.com/images.smartix.uk/2/apple/logo/C-20260209120645-20260210090954.png\",\n                \"thumbnail\": \"https://s3.eu-west-1.amazonaws.com/images.smartix.uk/2/apple/thumbnail/membership-apple-thumbnail-20250924134410.png\"\n            },\n            \"google\": {\n                \"hero\": \"https://s3.eu-west-1.amazonaws.com/images.smartix.uk/2/google/hero/bwclub-an-other-20260210095327.png\",\n                \"logo\": \"https://s3.eu-west-1.amazonaws.com/images.smartix.uk/2/google/logo/C-20260209120645-20260210091017.png\"\n            }\n        },\n        \"membership\": {\n            \"discount_percentage\": 10,\n            \"expiry_date\": \"20270213\",\n            \"history\": {\n                \"scans\": \"\"\n            },\n            \"member_name\": \"Bob\",\n            \"membership_number\": \"M123123\",\n            \"tier\": \"VIP\"\n        },\n        \"pass\": {\n            \"description\": \"\",\n            \"grouping\": {\n                \"id\": \"smartix-demo\",\n                \"index\": null\n            },\n            \"header\": \"{{membership.member_name}}\",\n            \"issuer_name\": \"Smartix.Demos\",\n            \"pass_id\": \"000-000-000\",\n            \"subheader\": \"MEMBER\",\n            \"title\": \"Black & White Club\"\n        },\n        \"scan\": {\n            \"disabled\": false,\n            \"disabled_date\": null,\n            \"note\": null\n        }\n    }\n}\n\n

\n","urlObject":{"path":["getTemplateVariables",":template_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"5279aaa9-8b7d-4358-8571-2311bdfb366e","type":"any","value":"smartix_membership_EKP_L31_RAB_MPA_BNY","key":"template_id"}]}},"response":[],"_postman_id":"8c7140db-9b45-41dd-8226-e0c76adeea6a"},{"name":"Check template sync state","id":"17532045-e97d-4ad9-bd77-b56ade150c27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/checkSyncState/:template_id","description":"

Get template sync state

This endpoint is used to determine whether any passes required synchronising. When template variables or pass design is changed, issued passes do not automatically pick up those changes. You must perform a sync to do so.

This function is used to determine whether a sync is required and if so, how many passes need to be synced and what the credit cost will be.

Not all passes wil change because of a templaet variable change. Some may use the template variable as a default, but have theor own value. In which case, only those without their own value woudl need to be updated.

If content changes for a pass, then all google passes must have the new content sent to Google server. However, for Apple, only those passes currently installed on Apple devices must be synced. Hence, typically you wil find that the apple_count is lower than the goolge_count.

NOTE: The sync check runs asynchronously. The result of this function will either be the result, or it will be a

Returns

A variables object

Request

Method: GET
\n
URL:{passes_url}/checkSyncState/:template_id
\n
Headers:
\n
- x-api-key : Your API key
\n
URL parameters
\n
- template_id (string) : Template ID
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- apple_count : (integer) number of apple passes that must be synced
  \n
- google_count : (integer) number of google passes that must be synced
  \n
- total_count : (integer) : total number of passes to be synced. This is the total number of unique passes. So if a pass is represented in both apple_count and google_count it wil be counted only once. Hence, total_count will usually be less than the sum of apple_count + google_count.
  \n
- credit_costs : (integer) The number of credits which will be consumed by a sync
  \n
- sync_initiated_ts : {ISO datetime string) date and time sync was initiated
  \n
- sync_completed_ts : (ISO datetime string) date and time sync was completed
  \n
- template_id : {string) The template ID for which the sync reports relates.
  \n
\n

Example response

{\n    \"apple_count\": 0,\n    \"credit_cost\": 0,\n    \"google_count\": 0,\n    \"ok\": true,\n    \"sync_completed_ts\": null,\n    \"sync_initiated_ts\": null,\n    \"template_id\": \"smartix_membership_EKP_L31_RAB_MPA_BNY\",\n    \"total_count\": 0\n}\n\n

Response (not complete)

Status: 303
\n
Content-Type: application/json
\n
Headers:
\n
- Content-Type: application/json
  \n
- Location: URL to redirtect to. Will be a GET request.
  \n
- X-redirect-reason: \"Not yet ready\"
  \n
- Retry-After: Tiem to wait before redirecting
  \n
- Client-Request-Id: Your [optional] request ID
  \n
- awsRequestId : AWS request ID
  \n
- Processing-Started: Date and time processign started or \"Not yet started\"
  \n
\n

\n","urlObject":{"path":["checkSyncState",":template_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"0b064871-6ff4-492e-8b1a-57b48874291b","type":"any","value":"smartix_membership_EKP_L31_RAB_MPA_BNY","key":"template_id"}]}},"response":[],"_postman_id":"17532045-e97d-4ad9-bd77-b56ade150c27"},{"name":"Run a template sync check","id":"ea17d309-8d51-469c-beb8-436c9e171c2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/syncCheck/:template_id","description":"

Get template sync state

This function is used to determine whether a sync is required and if so, how many passes need to be synced and what the credit cost will be.

NOTE: The sync check runs asynchronously. The result of this function will either be the result, or it will be a

Returns

A variables object

Request

Method: GET
\n
URL:{passes_url}/checkSyncState/:template_id
\n
Headers:
\n
- x-api-key : Your API key
\n
URL parameters
\n
- template_id (string) : Template ID
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- apple_count : (integer) number of apple passes that must be synced
  \n
- google_count : (integer) number of google passes that must be synced
  \n
- total_count : (integer) : total number of passes to be synced. This is the total number of unique passes. So if a pass is represented in both apple_count and google_count it wil be counted only once. Hence, total_count will usually be less than the sum of apple_count + google_count.
  \n
- credit_costs : (integer) The number of credits which will be consumed by a sync
  \n
- sync_initiated_ts : {ISO datetime string) date and time sync was initiated
  \n
- template_id : {string) The template ID for which the sync reports relates.
  \n
\n

Example response

{\n    \"apple_count\": 0,\n    \"credit_cost\": 0,\n    \"google_count\": 0,\n    \"ok\": true,\n    \"template_id\": \"smartix_membership_EKP_L31_RAB_MPA_BNY\",\n    \"total_count\": 0\n}\n\n

Response (not complete)

Status: 303
\n
Content-Type: application/json
\n
Headers:
\n
- Content-Type: application/json
  \n
- Location: URL to redirtect to. Will be a GET request.
  \n
- X-redirect-reason: \"Not yet ready\"
  \n
- Retry-After: Tiem to wait before redirecting
  \n
- Client-Request-Id: Your [optional] request ID
  \n
- awsRequestId : AWS request ID
  \n
- Processing-Started: Date and time processign started or \"Not yet started\"
  \n
\n

\n","urlObject":{"path":["syncCheck",":template_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"74f6ee1b-c7d6-4074-8442-a36efe6f60ee","type":"any","value":"smartix_membership_EKP_L31_RAB_MPA_BNY","key":"template_id"}]}},"response":[],"_postman_id":"ea17d309-8d51-469c-beb8-436c9e171c2e"},{"name":"Run template sync","id":"fa795b86-f222-4ce0-8932-9e1afc14dc36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/initiateSync/:template_id","description":"

Get template sync state

This function is used to determine whether a sync is required and if so, how many passes need to be synced and what the credit cost will be.

NOTE: The sync check runs asynchronously. The result of this function will either be the result, or it will be a

Returns

A variables object

Request

Method: GET
\n
URL:{passes_url}/checkSyncState/:template_id
\n
Headers:
\n
- x-api-key : Your API key
\n
URL parameters
\n
- template_id (string) : Template ID
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- apple_count : (integer) number of apple passes that must be synced
  \n
- google_count : (integer) number of google passes that must be synced
  \n
- total_count : (integer) : total number of passes to be synced. This is the total number of unique passes. So if a pass is represented in both apple_count and google_count it wil be counted only once. Hence, total_count will usually be less than the sum of apple_count + google_count.
  \n
- credit_costs : (integer) The number of credits which will be consumed by a sync
  \n
- sync_initiated_ts : (ISO datetime string) date and time sync was initiated
  \n
- template_id : {string) The template ID for which the sync reports relates.
  \n
\n

Example response

{\n    \"apple_count\": 0,\n    \"credit_cost\": 0,\n    \"google_count\": 0,\n    \"ok\": true,\n    \"template_id\": \"smartix_membership_EKP_L31_RAB_MPA_BNY\",\n    \"total_count\": 0\n}\n\n

Response (not complete)

Status: 303
\n
Content-Type: application/json
\n
Headers:
\n
- Content-Type: application/json
  \n
- Location: URL to redirtect to. Will be a GET request.
  \n
- X-redirect-reason: \"Not yet ready\"
  \n
- Retry-After: Tiem to wait before redirecting
  \n
- Client-Request-Id: Your [optional] request ID
  \n
- awsRequestId : AWS request ID
  \n
- Processing-Started: Date and time processign started or \"Not yet started\"
  \n
\n

\n","urlObject":{"path":["initiateSync",":template_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"9ae3d961-ef0a-4436-883a-f1e8613b729e","type":"any","value":"smartix_membership_EKP_L31_RAB_MPA_BNY","key":"template_id"}]}},"response":[],"_postman_id":"fa795b86-f222-4ce0-8932-9e1afc14dc36"},{"name":"Get Passes","id":"80f76d46-8a0c-4111-b48b-8a2fc35dbf3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"passes\" : [\n \"39JH-XWF6-CGMU-QXQ4\",\n \"DXPQ-MFBF-6AG4-UGQK\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/getPasses","description":"

Get passes

This endpoint is used to retrieve data relating to a list of issued passes.

It is essentially the same as getPass, but allows you to retieve data about several passes in a single request,

Returns

An array of pass data (see getPass)

Request

Method: POST
\n
URL:{passes_url}/getPasses:template_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Body
\n

Example Requests

{\n    \"passes\" : [\n        \"39JH-XWF6-CGMU-QXQ4\",\n        \"DXPQ-MFBF-6AG4-UGQK\"\n    ]\n}\n\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- passes : (array) of pass IDs
\n

Example response

{\n    \"ok\": true,\n    \"passes\": [\n        {\n            \"apple_installs\": 0,\n            \"apple_sync_hash\": null,\n            \"apple_url\": \"https://api.smartix.uk/pkpass/\",\n            \"charge_applied\": 1,\n            \"client_id\": 0,\n            \"creation_timestamp\": \"20260528135725\",\n            \"expiry_date\": null,\n            \"google_installs\": 0,\n            \"google_object_sync_hash\": \"3e9d75865d08c2205441ff9d53685aa6e61234dee67b3e375cc148eb31e43cb9\",\n            \"google_url\": \"https://pay.google.com/gp/v/save/\",\n            \"grouping_id\": null,\n            \"grouping_index\": null,\n            \"has_smartix_advert\": 0,\n            \"key_id\": 1,\n            \"key_type\": \"key\",\n            \"last_modified_apple_timestamp\": \"20260528135725\",\n            \"last_modified_google_timestamp\": \"20260528135725\",\n            \"mode\": \"live\",\n            \"pass_id\": \"39JH-XWF6-CGMU-QXQ4\",\n            \"scanner_audit_data_enc\": [],\n            \"template_id\": \"offer\",\n            \"update_counter\": 0,\n            \"variables\": {\n                \"event\": {\n                    \"ticket\": {\n                        \"scanned\": false,\n                        \"scanned_datetime\": \"20260101000000\"\n                    }\n                },\n                \"pass\": {\n                    \"pass_id\": \"39JH-XWF6-CGMU-QXQ4\"\n                },\n                \"scan\": {\n                    \"disabled\": false,\n                    \"disabled_date\": \"20260101000000\",\n                    \"note\": \"no note\"\n                }\n            }\n        },\n        {\n            \"apple_installs\": 0,\n            \"apple_sync_hash\": null,\n            \"apple_url\": \"https://api.smartix.uk/pkpass/\",\n            \"charge_applied\": 1,\n            \"client_id\": 0,\n            \"creation_timestamp\": \"20260528140103\",\n            \"expiry_date\": null,\n            \"google_installs\": 0,\n            \"google_object_sync_hash\": \"f112510517a29b89a9051b117803b09af814972c2ce47aeabce8020cfb72ff51\",\n            \"google_url\": \"https://pay.google.com/gp/v/save/\",\n            \"grouping_id\": null,\n            \"grouping_index\": null,\n            \"has_smartix_advert\": 0,\n            \"key_id\": 1,\n            \"key_type\": \"key\",\n            \"last_modified_apple_timestamp\": \"20260528140103\",\n            \"last_modified_google_timestamp\": \"20260528140103\",\n            \"mode\": \"live\",\n            \"pass_id\": \"DXPQ-MFBF-6AG4-UGQK\",\n            \"scanner_audit_data_enc\": [],\n            \"template_id\": \"offer\",\n            \"update_counter\": 0,\n            \"variables\": {\n                \"event\": {\n                    \"ticket\": {\n                        \"scanned\": false,\n                        \"scanned_datetime\": \"20260101000000\"\n                    }\n                },\n                \"pass\": {\n                    \"pass_id\": \"DXPQ-MFBF-6AG4-UGQK\"\n                },\n                \"scan\": {\n                    \"disabled\": false,\n                    \"disabled_date\": \"20260101000000\",\n                    \"note\": \"no note\"\n                }\n            }\n        }\n    ]\n}\n\n

\n","urlObject":{"path":["getPasses"],"host":["{{passes_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"80f76d46-8a0c-4111-b48b-8a2fc35dbf3f"},{"name":"Get Pass Notifications","id":"95fc8c1d-04c5-4dcf-b86f-3614ed018bf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/getPassNotifications/:pass_id","description":"

Get pass notifications

This endpoint is used to retrieve notifications sent to a pass.

Request

Method: GET
\n
URL: {{passes_url}}/getPassNotifications/:template_id/:pass_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- notifications : (array) Array of notifications
  \n
  - ts : (ISO datetime string) : Notification timestamp
    \n
  - message : (string) Notification message
    \n
  \n
\n

{\n    \"notifications\": [\n        {\n            \"message\": \"Your renewal is due\",\n            \"ts\": \"202511051333\"\n        },\n        {\n            \"message\": \"Your policy has been renewed\",\n            \"ts\": \"202512011200\"\n        }\n}\n\n

\n","urlObject":{"path":["getPassNotifications",":pass_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"8f524ec7-b9c2-43aa-8b7c-dde9da5b0af9","type":"any","value":"39JH-XWF6-CGMU-QXQ4","key":"pass_id"}]}},"response":[],"_postman_id":"95fc8c1d-04c5-4dcf-b86f-3614ed018bf5"},{"name":"Get Active Pass Count","id":"678938bd-5d96-4320-968d-60cc1605250c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/getActivePassesCount","description":"

Get active pass count

This endpoint is used to retrieve a count of your current number of active passes.

Request

Method: GET
\n
URL: {{passes_url}}/getActivePassesCount
\n
Headers:
\n
- x-api-key : Your API key
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- templates : (array) One item per template
  \n
  - template_id : (string) Template ID
    \n
  - name : (string) Template name
    \n
  - active_count : (integer) Number of active (live and not expired) passes associated with this template
    \n
  - expired_count : (integer) Number of live, but expired passes associated with this template
    \n
  - apple_install_count : (integer) Numebr of passes installed on Apple devices
    \n
  - google_install_count : (integer) Numebr of passes installed on Android devices
    \n
  \n
- total : (integer) Total number of active passes
  \n
\n

{\n    \"ok\": true,\n    \"templates\": [\n        {\n            \"active_count\": 18,\n            \"apple_install_count\": 2,\n            \"expired_count\": 0,\n            \"google_install_count\": 2,\n            \"name\": \"Alice Loves Crafting Loyalty\",\n            \"template_id\": \"smartix_loyalty_N1B_E5M_D2B_2GD_DBT\"\n        },\n        {\n            \"active_count\": 3,\n            \"apple_install_count\": 6,\n            \"expired_count\": 0,\n            \"google_install_count\": 3,\n            \"name\": \"Aston Martin\",\n            \"template_id\": \"other_s_VJC_9L8_C9A_5Y7_Q5M\"\n        },\n    ],\n    \"total\": 1\n}\n\n

\n","urlObject":{"path":["getActivePassesCount"],"host":["{{passes_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"678938bd-5d96-4320-968d-60cc1605250c"},{"name":"Delete Pass","id":"3ef18e9a-6aa9-4184-ab8d-6a8878b0dc55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/deletePass/:pass_id","description":"

Delete pass

This endpoint is used to delete a pass

Request

Method: DELETE
\n
URL: {{passes_url}}/deletePass/:pass_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
\n

Response

Status: 200
\n
Content-Type: application/json
\n

NOTE: No warning is given if the requested pass does not exist / has already been deleted.

\n","urlObject":{"path":["deletePass",":pass_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"4ab9d95b-15e2-4f30-90df-5486374c2fe8","type":"any","value":"DXPQ-MFBF-6AG4-UGQK","key":"pass_id"}]}},"response":[],"_postman_id":"3ef18e9a-6aa9-4184-ab8d-6a8878b0dc55"},{"name":"Delete Passes","id":"046a0778-79ca-4379-aa19-25e402128790","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"passes\" : [\n \"LOYALTY_GROUP_9\",\n \"LOYALTY_GROUP_10\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/deletePasses","description":"

Delete passes

This endpoint is used to delete a list of passes.

Request

Method: GET
\n
URL: {{passes_url}}/deletePasses
\n
Headers:
\n
- x-api-key : Your API key
\n
Body:
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
passes (array) : array of pass_id
\n

Returns

num_passes_deleted : (string) A conformation of the number of passes deleted

NOTE: No warning is given if any of the requestes passes do not exist / have already been deleted.

{\n    \"num_passes_deleted\": 0,\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["deletePasses"],"host":["{{passes_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"046a0778-79ca-4379-aa19-25e402128790"},{"name":"Patch Pass","id":"37be7bd3-a723-4a4b-ac6a-ba9882fe4ea6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"policy\": {\n \"policy_number\": \"X98765\"\n },\n \"policy.vehicle\": \"Ford Puma\",\n \"pass.validity.end\": null,\n \"relevance\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/patchPass/:pass_id","description":"

Patch Pass

This endpoint is used to update an existing pass.

Only the supplied fields are modified. All other fields will retain their existing value. To remove a field send a null value.

See makePass function for details of the request data content.

if you are replacing the entire pass content, please use the updatePass method instead.

Request

Method: PATCH
\n
URL: {{passes_url}}/patchPass/:pass_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
\n
Body
\n
- JSON pass data (only fields that are to be updated)
\n

{\n   \"event_date\": \"20261101120000\"\n}\n\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body : {ok:true} if successful
\n

\n","urlObject":{"path":["patchPass",":pass_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"29886fc8-4020-43fc-8a11-dbfceecfe8d8","type":"any","value":"EVHB-3LUV-R3KT","key":"pass_id"}]}},"response":[],"_postman_id":"37be7bd3-a723-4a4b-ac6a-ba9882fe4ea6"},{"name":"Patch Template Variables","id":"eff315c9-854e-4b24-b677-4362fe985a74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"membership\": {\n \"tier\": \"Standard\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/patchTemplateVariables/:template_id/:sync_mode","description":"

Patch template variables

This endpoint is used to patch template (default pass) variables

Variables provided are merged with the existing variables with new values overwriting old values.

After merge an optional sync check / sync is initiated. If using check_only, you must also use the checkSyncState function to get the result.

Any passes where content changes as a result of the new template values will be updated.

Request

Method: PATCH
\n
URL:{passes_url}/patchTemplateVariables/:template_id/:sync_mode
\n
Headers:
\n
- x-api-key : Your API key
\n
URL parameters
\n
- template_id (string) : Template ID
  \n
- sync_mode (string) : none [default] = do not perform a sync check, check_only=initiate a sync check after updating variables, auto_if_needed=perform a sycn check and initiate the sync if needed.
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- ok (boolean) : true if request suceeded
\n

\n","urlObject":{"path":["patchTemplateVariables",":template_id",":sync_mode"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"718467f1-306e-44b1-b2e3-464035c4e946","type":"any","value":"smartix_membership_EKP_L31_RAB_MPA_BNY","key":"template_id"},{"id":"b60ca811-bae5-43db-8353-84ede8967dfc","description":{"content":"

none=do not do a sync check, check_only=perform a check aftet update, auto_if_needed=check and initiate sync if needed

\n","type":"text/plain"},"type":"any","value":"none","key":"sync_mode"}]}},"response":[],"_postman_id":"eff315c9-854e-4b24-b677-4362fe985a74"},{"name":"Patch Passes","id":"d0198121-1ecd-4118-ac5b-bcddd3f667e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{passes_url}}/patchPasses/:template_id","description":"

Patch Passes

This endpoint is used to update common instance data for a supplied list of passes

Only the supplied fields are modified. All other fields will retain their existing value. To remove a field send a null value.

Be aware that the data values you supply will be applied to all of the listed passes. So use this function only for updating data that applies to all of those passes.

You cannot use this function to patch different values to a range of passes. To do that use patchPass for each pass you wish to update.

See makePass function for details of the request data content.

if you are repreplacing the entire pass content, please use the update_Pass_ method instead.

Request

Method: PATCH
\n
URL: {{passes_url}}/patchPass/:template_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- template_id (string): The ID of the template.
  \n
- pass_id (string): The ID of the pass.
  \n
\n
Body
\n
- JSON pass data (only fields that are to be updated)
\n

{\n   \"event_date\": \"20261101120000\"\n}\n\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body (See getPass. THis function returns the same full pass data)
\n

\n","urlObject":{"path":["patchPasses",":template_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"0a146007-a10e-4cbe-ba83-b429df813b59","type":"any","value":"insurance_demo","key":"template_id"}]}},"response":[],"_postman_id":"d0198121-1ecd-4118-ac5b-bcddd3f667e2"},{"name":"Patch All Passes","id":"806d7544-8dea-4806-89aa-3b55ec17d63a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"policy.vehicle\": \"BMW i5\",\n \"relevance\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/patchAllPasses/:template_id","description":"

Patch All Passes

This endpoint is used to update common instance data for all passes

Only the supplied fields are modified. All other fields will retain their existing value. To remove a field send a null value.

Be aware that the data values you supply will be applied to ALL passes. So use this function only for updating data that applies to all passes.

You cannot use this function to patch different values to a range of passes. To do that use patchPass for each pass you wish to update.

See makePass function for details of the request data content.

Request

Method: PATCH
\n
URL: {{passes_url}}/patchPass/:template_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- template_id (string): The ID of the template.
  \n
- pass_id (string): The ID of the pass.
  \n
\n
Body
\n
- JSON pass data (only fields that are to be updated)
\n

{\n   \"event_date\": \"20261101120000\"\n}\n\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body (See getPass. This function returns the same full pass data)
\n

\n","urlObject":{"path":["patchAllPasses",":template_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"97183c9f-25f5-4b66-bf03-6c4f90c4292a","type":"any","value":"insurance_demo","key":"template_id"}]}},"response":[],"_postman_id":"806d7544-8dea-4806-89aa-3b55ec17d63a"},{"name":"Notify pass","id":"5f3509ae-6b32-4001-9bfd-0aa9d27b7aa5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

Offline key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"notification\" : \"Hello\"\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/notifyPass/:pass_id","description":"

Notify Pass

This endpoint is used to send a notifiation to a pass.

The handling of Apple and Google is slightly different:

Apple

A lock screen alert is displayed showing the content of the new notification.

Two extra fields are included in the details section of Apple passes: notification and messages.

The new notification is displayed in the notification field. Any prior notifications are lsted in the messages field.

Google

A lock screen notification indicates that a notification has been received for a pass (text is fixed by Google).

All notifications (new one, plus any prior ones) are displayed in a messages field in the opass details section.

Fair use policy

We expect you to use this feature in a reasonable manner. DO NOT send unsolicited notifications. Frequent notificsations to large numbers of passes will be reviewed an if considered to be ouside of reasonable and fair use then a warning will be give. Repeat offence coudl lead to your account being suspended.

For details seehttps://docs.smartix.uk/terms/fair-use-policy

Request

Method: POST
\n
URL: {{passes_url}}/notifyPass/:pass_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- pass_id (string): The ID of the pass.
\n
Body
\n
- title : (string) Notification title
  \n
- body (string) Notification body content
  \n
\n

{\n    \"title\" : \"New itinerary\",\n    \"body\" : \"We have calculated a new itinerary for your journey. See ticket details.\"\n}\n\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- notifications : (array) - array of prior and new notifications
  \n
  - title : (string) Notification title
    \n
  - body : (string) Notification body conents
    \n
  - timestamp : (ISO datetime string) Timestamp of notification.
    \n
  \n
\n

{\n    \"notifications\": [\n        {\n            \"body\": \"We have calculated a new itinerary for your journey. See ticket details.\",\n            \"timestamp\": \"202505161436\",\n            \"title\": \"New itinerary\"\n        }\n    ]\n}\n\n

\n","urlObject":{"path":["notifyPass",":pass_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"6e98be24-aaf2-45ad-9eab-fed57fae568d","type":"any","value":"39JH-XWF6-CGMU-QXQ4","key":"pass_id"}]}},"response":[],"_postman_id":"5f3509ae-6b32-4001-9bfd-0aa9d27b7aa5"},{"name":"Notify passes","id":"4b0939bb-999b-4f1a-b860-0e7bd0c6156a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

Offline key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"pass_ids\": [\n \"39JH-XWF6-CGMU-QXQ4\"\n ],\n \"notification\": \"Hello World\"\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/notifyPasses/:template_id","description":"

Notify Passes

This endpoint is used to send a notifiation to a list of passes

See notifyPass for details.

Where notifyPass send notifications immediately, notifyPasses add notifications to a queue. That queue is processed in order so that notifications are delivered as quickly as possible. If delivery fails, then a notification remains in the queue and is processed again.

If you need to notify multiple passes this function is more efficient that notifyPass and should be used in preference.

If you need to notify all issued passes then use notifyAllPasses function.

Fair use policy

For details seehttps://docs.smartix.uk/terms/fair-use-policy

Request

Method: POST
\n
URL: {{passes_url}}/notifyPasses/:template_id
\n
Headers:
\n
x-api-key : Your API key
\n
Path Parameters:
\n
- template_id (string): The ID of the template.
\n
Body
\n
- pass_ids : (array) Array of pss IDs
  \n
- notification (string) The notification message
  \n
\n

{\n    \"pass_ids\": [\n        \"LOYALTY_GROUP_7\",\n        \"LOYALTY_GROUP_8\"\n    ],\n    \"notification\": \"Hello World\"\n}\n\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- queued : (integer) A confirmation of the number of notifications queued for delivery to passes.
\n

{\n    \"ok\": true,\n    \"queued\": 2\n}\n\n

\n","urlObject":{"path":["notifyPasses",":template_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"7121342d-3d97-477d-a3cc-0affe7463515","type":"any","value":"offer","key":"template_id"}]}},"response":[],"_postman_id":"4b0939bb-999b-4f1a-b860-0e7bd0c6156a"},{"name":"Notify all passes","id":"e2b28aa7-722c-477c-9705-d31142e4923c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

Offline key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"notification\" : \"Testing notify stamps 5\"\n}","options":{"raw":{"language":"json"}}},"url":"{{passes_url}}/notifyAll/:template_id","description":"

Notify all passes

This end point send a notification to all issued passes for a given template.

Notifications are queued and will be delivered as quicly as possible.

If you do not need a notification to go to all passes consider notifyPasses or notifyPass instead.

Fair use policy

For details seehttps://docs.smartix.uk/terms/fair-use-policy

Request

Method: PUT
\n
URL: {{passes_url}}/notifyAll/:template_id/
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- template_id (string): The ID of the template.
\n
Body
\n
- title : (string) Notification title
  \n
- body (string) Notification body content
  \n
\n

{\n    \"notification\" : \"Testing notify all\"\n}\n\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- notifications : (array) - array of prior and new notifications
  \n
  - class_result : (object)
    \n
    - google_result : (boolean) confirms that update sent to google API
      \n
    - message_id :(string) ID assigned by google
      \n
    - template_id : (string) Confirmation of the template notification sent to
      \n
    \n
  - queued : (integer) Number of [installed] apple passes queued for notification.
    \n
  \n
\n

{\n    \"class_result\": {\n        \"google_result\": true,\n        \"message_id\": \"Q735UYD47YBB\",\n        \"template_id\": \"loyalty_GHL_5K8_YAP_DNX_PNT\"\n    },\n    \"ok\": true,\n    \"queued\": 13\n}\n\n

\n","urlObject":{"path":["notifyAll",":template_id"],"host":["{{passes_url}}"],"query":[],"variable":[{"id":"d668c317-3f00-44b5-b24e-c13233ee6a51","type":"any","value":"offer","key":"template_id"}]}},"response":[],"_postman_id":"e2b28aa7-722c-477c-9705-d31142e4923c"}],"id":"47fc6504-dda0-4ee0-9adb-0aba51357bf4","description":"

Functions relating to creating, updating, deleting and quering passes.

Also funciton for sending notifications.

\n","_postman_id":"47fc6504-dda0-4ee0-9adb-0aba51357bf4"},{"name":"Client API","item":[{"name":"get Users","id":"37e4f0fe-ef5a-4d20-9f41-1621706c2848","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n"}],"url":"{{clients_url}}/getUsers","description":"

Get users

This endpoint is used to retrieve a list of users associated with your account.

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: GET
\n
URL: {{clients_url}}/getUsers
\n
Headers:
\n
- x-api-key : Your API key
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- users : (array)
  \n
  - client_admin_enabled : (boolean) 1= user is authorised to mange client data
    \n
  - email : (string) Email address
    \n
  - scanner_enabled : (boolean) 1= user is authorised to use Smartix Scan App
    \n
  - studio_enabled : (boolean) 1 = user is authorised to use Smartix Studio
    \n
  - user_enabled : (boolean) 0 = user disabled, All access is restricted
    \n
  - user_id : (integer) User ID
    \n
  - username : (string) Username
    \n
  \n
\n

{\n    \"ok\": true,\n    \"users\": [\n        {\n            \"client_admin_enabled\": 1,\n            \"email\": \"user1@null.com\",\n            \"scanner_enabled\": 1,\n            \"studio_enabled\": 1,\n            \"user_enabled\": 1,\n            \"user_id\": 1,\n            \"username\": \"User 1\"\n        },\n        {\n            \"client_admin_enabled\": 0,\n            \"email\": \"user2@null.com\",\n            \"scanner_enabled\": 1,\n            \"studio_enabled\": 0,\n            \"user_enabled\": 1,\n            \"user_id\": 38,\n            \"username\": \"User 2\"\n        }\n    ]\n}\n\n

\n","urlObject":{"path":["getUsers"],"host":["{{clients_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"37e4f0fe-ef5a-4d20-9f41-1621706c2848"},{"name":"Statistic = get pass activity (scans) (specified template)","id":"b334e8df-570e-4598-81d2-f6a3f4200275","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n"}],"url":"{{clients_url}}/getClientStatisticsScans/:template_id/:period_days","description":"

Get pass activity (statistics)

This endpoint is used to retrieve the data used in the studio Pass Activity chart

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: GET
\n
URL: {{clients_url}}/getClientStatisticsScans/:template_id/:period_days
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- template_id (string): The ID of the template to report on.
  \n
- period_days (integer): The number of days to include in the report.
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n

{\n    \"extraTotals\": {\n        \"credit\": 0,\n        \"debit\": 0,\n        \"scan\": 2,\n        \"scanner\": 2,\n        \"scans\": 2,\n        \"shopify\": 0\n    },\n    \"ok\": true,\n    \"scanTrend\": [\n        {\n            \"action\": \"scan\",\n            \"bucket_action_label\": \"16 Aug · scan\",\n            \"bucket_label\": \"16 Aug\",\n            \"bucket_sort\": \"2026-08-16\",\n            \"scanner\": 1,\n            \"shopify\": 0\n        },\n        {\n            \"action\": \"scan\",\n            \"bucket_action_label\": \"17 Aug · scan\",\n            \"bucket_label\": \"17 Aug\",\n            \"bucket_sort\": \"2026-08-17\",\n            \"scanner\": 1,\n            \"shopify\": 0\n        }\n    ],\n    \"scanTrendSeries\": [\n        {\n            \"key\": \"scanner\",\n            \"label\": \"Scanner\",\n            \"source\": \"scanner\"\n        },\n        {\n            \"key\": \"shopify\",\n            \"label\": \"Shopify\",\n            \"source\": \"shopify\"\n        }\n    ]\n}\n\n

\n","urlObject":{"path":["getClientStatisticsScans",":template_id",":period_days"],"host":["{{clients_url}}"],"query":[],"variable":[{"description":{"content":"

template ID

\n","type":"text/plain"},"type":"any","value":"smartix_membership_EKP_L31_RAB_MPA_BNY","key":"template_id"},{"description":{"content":"

choice of 1,7,31,92,183,365 - number of days to include in report

\n","type":"text/plain"},"type":"any","value":"7","key":"period_days"}]}},"response":[],"_postman_id":"b334e8df-570e-4598-81d2-f6a3f4200275"},{"name":"Statistic = get pass types (in use)","id":"21346741-cbaf-457c-9182-cfcb54dc1d99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{clients_url}}/getClientStatisticsPassTypes","description":"

Get pass types (statistics)

This endpoint is used to retrieve the data used in the studio Pass Types chart

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: GET
\n
URL: {{clients_url}}/getClientStatisticsPassTypes
\n
Headers:
\n
- x-api-key : Your API key
\n

Response

Status: 200
\n
Content-Type: application/json
\n

{\n    \"ok\": true,\n    \"passTypeMix\": [\n        {\n            \"issued\": 70,\n            \"pass_type_name\": \"Loyalty Card\",\n            \"template_count\": 2\n        },\n        {\n            \"issued\": 21,\n            \"pass_type_name\": \"Stamp Card\",\n            \"template_count\": 1\n        },\n        {\n            \"issued\": 9,\n            \"pass_type_name\": \"Other (storecard)\",\n            \"template_count\": 5\n        },\n        {\n            \"issued\": 8,\n            \"pass_type_name\": \"Gift Card\",\n            \"template_count\": 3\n        },\n        {\n            \"issued\": 5,\n            \"pass_type_name\": \"Event Ticket\",\n            \"template_count\": 6\n        },\n        {\n            \"issued\": 1,\n            \"pass_type_name\": \"Membership Card (ID \",\n            \"template_count\": 1\n        },\n        {\n            \"issued\": 1,\n            \"pass_type_name\": \"Other (event)\",\n            \"template_count\": 2\n        },\n        {\n            \"issued\": 0,\n            \"pass_type_name\": \"Membership Card\",\n            \"template_count\": 1\n        },\n        {\n            \"issued\": 0,\n            \"pass_type_name\": \"Offer\",\n            \"template_count\": 2\n        },\n        {\n            \"issued\": 0,\n            \"pass_type_name\": \"Other (generic)\",\n            \"template_count\": 1\n        }\n    ]\n}\n\n

\n","urlObject":{"path":["getClientStatisticsPassTypes"],"host":["{{clients_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"21346741-cbaf-457c-9182-cfcb54dc1d99"},{"name":"Statistic = get pass template updates (specified template)","id":"70c1be35-3fb4-4e0c-b040-bebd3b0867d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{clients_url}}/getClientStatisticsTemplateChanges/:template_id/:period_days","description":"

Get template updates (statistics)

This endpoint is used to retrieve the data used in the studio Template Updates chart

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: GET
\n
URL: {{clients_url}}/getClientStatisticsTemplateChanges/:template_id/:period_days
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- template_id (string): The ID of the template to report on.
  \n
- period_days (integer): The number of days to include in the report.
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n

{\n    \"extraTotals\": {\n        \"templateUpdates\": 1,\n        \"templatesCreated\": 0\n    },\n    \"ok\": true,\n    \"templateLifecycle\": [\n        {\n            \"bucket_label\": \"May 2026\",\n            \"bucket_sort\": \"2026-05-01\",\n            \"created\": 0,\n            \"updated\": 1\n        }\n    ]\n}\n\n

\n","urlObject":{"path":["getClientStatisticsTemplateChanges",":template_id",":period_days"],"host":["{{clients_url}}"],"query":[],"variable":[{"id":"85b7c563-38da-4db4-8868-12c2c4ea68db","description":{"content":"

template ID

\n","type":"text/plain"},"type":"any","value":"smartix_membership_EKP_L31_RAB_MPA_BNY","key":"template_id"},{"id":"b49475bd-c602-4518-b936-cdf48dc4cb0b","description":{"content":"

1,7,31,92,183,365 - number of days to include in report

\n","type":"text/plain"},"type":"any","value":"365","key":"period_days"}]}},"response":[],"_postman_id":"70c1be35-3fb4-4e0c-b040-bebd3b0867d6"},{"name":"Statistic = get pass template updates (all templates)","id":"63b82ed8-443d-4351-8095-b016cbf7f3d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{clients_url}}/getClientStatisticsTemplateChanges/:period_days","description":"

Get template updates (statistics)

This endpoint is used to retrieve the data used in the studio Template Updates chart

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: GET
\n
URL: {{clients_url}}/getClientStatisticsTemplateChanges/:period_days
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- period_days (integer): The number of days to include in the report.
\n

Response

Status: 200
\n
Content-Type: application/json
\n

{\n    \"extraTotals\": {\n        \"templateUpdates\": 25,\n        \"templatesCreated\": 0\n    },\n    \"ok\": true,\n    \"templateLifecycle\": [\n        {\n            \"bucket_label\": \"Dec 2025\",\n            \"bucket_sort\": \"2025-12-01\",\n            \"created\": 0,\n            \"updated\": 2\n        },\n        {\n            \"bucket_label\": \"Apr 2026\",\n            \"bucket_sort\": \"2026-04-01\",\n            \"created\": 0,\n            \"updated\": 7\n        },\n        {\n            \"bucket_label\": \"May 2026\",\n            \"bucket_sort\": \"2026-05-01\",\n            \"created\": 0,\n            \"updated\": 5\n        },\n        {\n            \"bucket_label\": \"Jul 2026\",\n            \"bucket_sort\": \"2026-07-01\",\n            \"created\": 0,\n            \"updated\": 2\n        },\n        {\n            \"bucket_label\": \"Aug 2026\",\n            \"bucket_sort\": \"2026-08-01\",\n            \"created\": 0,\n            \"updated\": 9\n        }\n    ]\n}\n\n

\n","urlObject":{"path":["getClientStatisticsTemplateChanges",":period_days"],"host":["{{clients_url}}"],"query":[],"variable":[{"id":"f3ae3a4c-ebfc-4a1e-83bc-eae1cc9d23d2","description":{"content":"

1,7,31,92,183,365 - number of days to include in report

\n","type":"text/plain"},"type":"any","value":"365","key":"period_days"}]}},"response":[],"_postman_id":"63b82ed8-443d-4351-8095-b016cbf7f3d2"},{"name":"Statistic = get pass installs (specified template)","id":"b2717877-273e-4d5a-8c3f-bf8d61174886","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{clients_url}}/getClientStatisticsInstalls/:template_id/:period_days","description":"

Get pass installs (statistics)

This endpoint is used to retrieve the data used in the studio Pass Installs chart

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: GET
\n
URL: {{clients_url}}/getClientStatisticsInstalls/:template_id/:period_days
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- template_id (string): The ID of the template to report on.
  \n
- period_days (integer): The number of days to include in the report.
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n

{\n    \"extraTotals\": {\n        \"appleInstalls\": 2,\n        \"googleInstalls\": 3\n    },\n    \"installTrend\": [\n        {\n            \"apple_installs\": 0,\n            \"bucket_label\": \"May 2026\",\n            \"bucket_sort\": \"2026-05-01\",\n            \"google_installs\": 1\n        },\n        {\n            \"apple_installs\": 2,\n            \"bucket_label\": \"Jun 2026\",\n            \"bucket_sort\": \"2026-06-01\",\n            \"google_installs\": 0\n        },\n        {\n            \"apple_installs\": 0,\n            \"bucket_label\": \"Jul 2026\",\n            \"bucket_sort\": \"2026-07-01\",\n            \"google_installs\": 2\n        }\n    ],\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["getClientStatisticsInstalls",":template_id",":period_days"],"host":["{{clients_url}}"],"query":[],"variable":[{"id":"88c325c4-c04c-4a1b-91cc-94a4f2fa40cf","description":{"content":"

template ID

\n","type":"text/plain"},"type":"any","value":"smartix_membership_EKP_L31_RAB_MPA_BNY","key":"template_id"},{"id":"be5d06a8-938b-46a4-93ff-86e60d3dfb10","description":{"content":"

1,7,31,92,183,365 - number of days to include in report

\n","type":"text/plain"},"type":"any","value":"365","key":"period_days"}]}},"response":[],"_postman_id":"b2717877-273e-4d5a-8c3f-bf8d61174886"},{"name":"Statistic = get pass installs (all templates)","id":"04e2c58b-7219-48f9-b790-ca42ea8fa44c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{clients_url}}/getClientStatisticsInstalls/:period_days","description":"

Get pass installs (statistics)

This endpoint is used to retrieve the data used in the studio Pass Installs chart

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: GET
\n
URL: {{clients_url}}/getClientStatisticsInstalls/:period_days
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- period_days (integer): The number of days to include in the report.
\n

Response

Status: 200
\n
Content-Type: application/json
\n

{\n    \"extraTotals\": {\n        \"appleInstalls\": 31,\n        \"googleInstalls\": 15\n    },\n    \"installTrend\": [\n        {\n            \"apple_installs\": 4,\n            \"bucket_label\": \"Dec 2025\",\n            \"bucket_sort\": \"2025-12-01\",\n            \"google_installs\": 0\n        },\n        {\n            \"apple_installs\": 9,\n            \"bucket_label\": \"Mar 2026\",\n            \"bucket_sort\": \"2026-03-01\",\n            \"google_installs\": 0\n        },\n        {\n            \"apple_installs\": 2,\n            \"bucket_label\": \"Apr 2026\",\n            \"bucket_sort\": \"2026-04-01\",\n            \"google_installs\": 1\n        },\n        {\n            \"apple_installs\": 14,\n            \"bucket_label\": \"May 2026\",\n            \"bucket_sort\": \"2026-05-01\",\n            \"google_installs\": 12\n        },\n        {\n            \"apple_installs\": 2,\n            \"bucket_label\": \"Jun 2026\",\n            \"bucket_sort\": \"2026-06-01\",\n            \"google_installs\": 0\n        },\n        {\n            \"apple_installs\": 0,\n            \"bucket_label\": \"Jul 2026\",\n            \"bucket_sort\": \"2026-07-01\",\n            \"google_installs\": 2\n        }\n    ],\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["getClientStatisticsInstalls",":period_days"],"host":["{{clients_url}}"],"query":[],"variable":[{"id":"26d77f1f-c7b6-4c7f-9071-23aa0f97899f","description":{"content":"

1,7,31,92,183,365 - number of days to include in report

\n","type":"text/plain"},"type":"any","value":"365","key":"period_days"}]}},"response":[],"_postman_id":"04e2c58b-7219-48f9-b790-ca42ea8fa44c"},{"name":"Statistic = get pass adoption (specified template)","id":"e718309a-6e35-491d-89de-821db9997a02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{clients_url}}/getClientStatisticsAdoption/:template_id","description":"

Get pass adoption (statistics)

This endpoint is used to retrieve the data used in the studio Template Adoption chart

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: GET
\n
URL: {{clients_url}}/getClientStatisticsAdoption/:template_id/:period_days
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- template_id (string): The ID of the template to report on.
  \n
- period_days (integer): The number of days to include in the report.
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n

{\n    \"adoption\": [\n        {\n            \"active_passes\": 4,\n            \"apple_installs\": 2,\n            \"expired_passes\": 0,\n            \"google_installs\": 3,\n            \"issued\": 1,\n            \"template_id\": \"smartix_membership_EKP_L31_RAB_MPA_BNY\",\n            \"template_name\": \"Black & White Club\"\n        }\n    ],\n    \"extraTotals\": {\n        \"activePasses\": 4,\n        \"appleInstalls\": 2,\n        \"expiredPasses\": 0,\n        \"googleInstalls\": 3\n    },\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["getClientStatisticsAdoption",":template_id"],"host":["{{clients_url}}"],"query":[],"variable":[{"id":"8c27dc1e-91a4-45b0-95bb-8e994b95f26d","description":{"content":"

template ID

\n","type":"text/plain"},"type":"any","value":"smartix_membership_EKP_L31_RAB_MPA_BNY","key":"template_id"}]}},"response":[],"_postman_id":"e718309a-6e35-491d-89de-821db9997a02"},{"name":"Statistic = get pass adoption (all templates)","id":"17d39889-7acd-463e-b528-72a272265664","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{clients_url}}/getClientStatisticsAdoption","description":"

Get pass adoption (statistics)

This endpoint is used to retrieve the data used in the studio Template Adoption chart

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: GET
\n
URL: {{clients_url}}/getClientStatisticsAdoption/:period_days
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- period_days (integer): The number of days to include in the report.
\n

Response

Status: 200
\n
Content-Type: application/json
\n

{\n    \"adoption\": [\n        {\n            \"active_passes\": 18,\n            \"apple_installs\": 2,\n            \"expired_passes\": 0,\n            \"google_installs\": 3,\n            \"issued\": 70,\n            \"template_id\": \"smartix_loyalty_N1B_E5M_D2B_2GD_DBT\",\n            \"template_name\": \"Alice Loves Crafting Loyalty\"\n        },\n        {\n            \"active_passes\": 3,\n            \"apple_installs\": 12,\n            \"expired_passes\": 0,\n            \"google_installs\": 3,\n            \"issued\": 4,\n            \"template_id\": \"other_s_VJC_9L8_C9A_5Y7_Q5M\",\n            \"template_name\": \"Aston Martin\"\n        },\n        {\n            \"active_passes\": 1,\n            \"apple_installs\": 0,\n            \"expired_passes\": 0,\n            \"google_installs\": 0,\n            \"issued\": 0,\n            \"template_id\": \"generic_A0G_0B7_770_FMJ_QNB\",\n            \"template_name\": \"Auto Rescue\"\n        },\n        {\n            \"active_passes\": 4,\n            \"apple_installs\": 2,\n            \"expired_passes\": 0,\n            \"google_installs\": 3,\n            \"issued\": 1,\n            \"template_id\": \"smartix_membership_EKP_L31_RAB_MPA_BNY\",\n            \"template_name\": \"Black & White Club\"\n        }\n    ],\n    \"extraTotals\": {\n        \"activePasses\": 38,\n        \"appleInstalls\": 31,\n        \"expiredPasses\": 0,\n        \"googleInstalls\": 15\n    },\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["getClientStatisticsAdoption"],"host":["{{clients_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"17d39889-7acd-463e-b528-72a272265664"},{"name":"Statistic = get pass activity (all templates)","id":"708ed60a-81bf-4ab7-954b-56afcd835edd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{clients_url}}/getClientStatisticsScans/:period_days","description":"

Get users

This endpoint is used to retrieve a list of users associated with your account.

NOTE: You need an API key with client admin permission enabled to use thos function.

Request

Method: GET
\n
URL: {{clients_url}}/getUsers
\n
Headers:
\n
- x-api-key : Your API key
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- users : (array)
  \n
  - client_admin_enabled : (boolean) 1= user is authorised to mange client data
    \n
  - email : (string) Email address
    \n
  - scanner_enabled : (boolean) 1= user is authorised to use Smartix Scan App
    \n
  - studio_enabled : (boolean) 1 = user is authorised to use Smartix Studio
    \n
  - user_enabled : (boolean) 0 = user disabled, All access is restricted
    \n
  - user_id : (integer) User ID
    \n
  - username : (string) Username
    \n
  \n
\n

{\n    \"ok\": true,\n    \"users\": [\n        {\n            \"client_admin_enabled\": 1,\n            \"email\": \"user1@null.com\",\n            \"scanner_enabled\": 1,\n            \"studio_enabled\": 1,\n            \"user_enabled\": 1,\n            \"user_id\": 1,\n            \"username\": \"User 1\"\n        },\n        {\n            \"client_admin_enabled\": 0,\n            \"email\": \"user2@null.com\",\n            \"scanner_enabled\": 1,\n            \"studio_enabled\": 0,\n            \"user_enabled\": 1,\n            \"user_id\": 38,\n            \"username\": \"User 2\"\n        }\n    ]\n}\n\n

\n","urlObject":{"path":["getClientStatisticsScans",":period_days"],"host":["{{clients_url}}"],"query":[],"variable":[{"id":"882d9d32-d9f3-416b-b697-8d6364ac5273","description":{"content":"

1,7,31,92,183,365 - number of days to include in report

\n","type":"text/plain"},"type":"any","value":"7","key":"period_days"}]}},"response":[],"_postman_id":"708ed60a-81bf-4ab7-954b-56afcd835edd"},{"name":"Add User","id":"ee2c8b19-9b0e-4165-a44f-86def026b4ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\" : \"testuser\",\n \"email\" : \"test@null.com\",\n \"studio_enabled\" : 1\n}","options":{"raw":{"language":"json"}}},"url":"{{clients_url}}/addUser","description":"

Add user

This endpoint is used to add a new user to your account

The user wil recieve an email inviting them to follow a link to complete the creation of their account.

NOTE: You need an API key with client admin permission enabled to use thos function.

Request

Method: PUT
\n
URL: {{clients_url}}/addUser
\n
Headers:
\n
- x-api-key : Your API key
\n
Body
\n
- username : (string) account name for user *Required
  \n
- email : (string) email address of used *Required
  \n
- studio_enabled : (boolean) 1= User will have permission to access Smartix Studio *Default=0
  \n
- scanner_enabled : (boolean) 1= User will have permission to access Smartix Scan App *Default=0
  \n
- client_admin_enabled : (boolean) 1= User will have permission to administer your account (manage users, gets, invoices etc.) *Default=0
  \n
\n

{\n    \"username\" : \"testuser\",\n    \"email\" : \"test@null.com\",\n    \"studio_enabled\" : 1\n}\n\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- user_id : (string) ID of the newly created user
\n

{\n    \"ok\": true,\n    \"user_id\": 63\n}\n\n

\n","urlObject":{"path":["addUser"],"host":["{{clients_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ee2c8b19-9b0e-4165-a44f-86def026b4ad"},{"name":"Update User","id":"76400fdd-688d-49ae-9ec4-54cdd4da4206","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user\" : {\n \"username\" : \"bob\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{clients_url}}/saveUser/:user_id","description":"

Update user

This endpoint is used to update a user record

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: PATCH
\n
URL: {{client_url}}/saveUser/:user_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- user_id (string): The ID of the user.
\n
Body
\n
- user
  \n
  - username : (string) new username
    \n
  - email: (string) new email
    \n
  - user_enabled : (boolean) 1= Enabled, 0=Disabled
    \n
  - client_admin_enabled: (boolean) 1= Enabled, 0=Disabled
    \n
  - studio_enabled: (boolean) 1= Enabled, 0=Disabled
    \n
  - scanner_enabled: (boolean) 1= Enabled, 0=Disabled
    \n
  \n
\n

All items are optional. Just specify the items you wish to change. All other items will remain unchanged

{\n    \"user\" : {\n        \"username\" : \"bob\",\n        \"scanner_enabled\" : 1\n    }\n}\n\n

Response

Status: 200
\n
Content-Type: application/json
\n

{\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["saveUser",":user_id"],"host":["{{clients_url}}"],"query":[],"variable":[{"id":"2949d2ff-d089-4084-a548-95a3dd2886c5","type":"any","value":"62","key":"user_id"}]}},"response":[],"_postman_id":"76400fdd-688d-49ae-9ec4-54cdd4da4206"},{"name":"Toggle API Key Admin Access","id":"dfbe456c-217c-41c7-81a4-69d6df1a4abd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user\" : {\n \"username\" : \"bob\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{clients_url}}/toggleApiKeyAdminAccess/:key_id","description":"

Toggle API Key admin access

This endpoint is used to update an API Key to enable / disable access to admin functions

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: PATCH
\n
URL: {{client_url}}/toggleApiKeyAdminAccess/:key_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- key_id (string): The ID of the API key.
\n

Response

Status: 200
\n
Content-Type: application/json
\n

{\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["toggleApiKeyAdminAccess",":key_id"],"host":["{{clients_url}}"],"query":[],"variable":[{"id":"e0387c83-934c-4a16-9cec-0c9763c41d46","type":"any","value":"62","key":"key_id"}]}},"response":[],"_postman_id":"dfbe456c-217c-41c7-81a4-69d6df1a4abd"},{"name":"Delete User","id":"43f957d2-7faf-466d-b4f8-571485ec7816","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

Delete user

This endpoint is used to delete a user forom your account

NOTE: You need an API key with client admin permission enabled to use thos function.

Request

Method: DELETE
\n
URL: {{clients_url}}/deleteUser/:user_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- user_id (string): The ID of the user to be deleted.
\n

Response

Status: 200
\n
Content-Type: application/json
\n

{\n    \"ok\": true\n}\n\n

","urlObject":{"path":["deleteUser",":user_id"],"host":["{{clients_url}}"],"query":[],"variable":[{"id":"a7583322-6722-450e-94ea-9ac6c3fbe140","type":"any","value":"63","key":"user_id"}]}},"response":[],"_postman_id":"43f957d2-7faf-466d-b4f8-571485ec7816"},{"name":"get API Keys","id":"be21712e-cbbe-45aa-8774-3fc737d5bc84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{clients_url}}/getApiKeys","description":"

Get API Keys

This endpoint is used to retrieve a list of API keys

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: GET
\n
URL:{{clients_url}}/getApiKeys
\n
Headers:
\n
- x-api-key : Your API key
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- custom_api_access_enabled : (boolean) Indicates if you have custmer API access enabled. Contact support if disabled and you require it.
  \n
- keys : (array)
  \n
  - key_id : (integer) Key ID
    \n
  - key_name : (string) : Your choice of name for this key
    \n
  - key_enabled : (boolean) 0 = Key disabled
    \n
  - key_usage : (string) Key usage (custom, shopify or zapier)
    \n
  - key : (string) The API key
    \n
  - ip_allow_list : (array) Array of CIDR ranges your API key is limited to (optional)
    \n
  - allow_access_to_client_functions : (boolean) 1=Key can be used to acess clients api.
    \n
  \n
\n

{\n    \"custom_api_access_enabled\": true,\n    \"keys\": [\n         {\n            \"allow_access_to_client_functions\": 1,\n            \"ip_allow_list\": [\n                \"123.124.125.126/16\"\n            ],\n            \"key\": \"{{API KEY STRING}}\",\n            \"key_enabled\": 1,\n            \"key_id\": 4,\n            \"key_name\": \"my custom app\",\n            \"key_usage\": \"custom\"\n        },\n        {\n            \"allow_access_to_client_functions\": 1,\n            \"ip_allow_list\": [],\n            \"key\": \"{{API KEY STRING}}\",\n            \"key_enabled\": 1,\n            \"key_id\": 12,\n            \"key_name\": \"shopify store 1\",\n            \"key_usage\": \"shopify\"\n        },\n        {\n            \"allow_access_to_client_functions\": 0,\n            \"ip_allow_list\": [],\n            \"key\": \"{{API KEY STRING}}\",\n            \"key_enabled\": 1,\n            \"key_id\": 16,\n            \"key_name\": \"zapier integration\",\n            \"key_usage\": \"zapier\"\n        }\n    ],\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["getApiKeys"],"host":["{{clients_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"be21712e-cbbe-45aa-8774-3fc737d5bc84"},{"name":"Add API Key","id":"08cdf77b-2702-452e-a87e-8cc59ffbfd37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"key_name\": \"my new custom key\",\n \"key_usage\": \"custom\",\n \"ip_allow_list\": [\n \"203.0.113.10\",\n \"198.51.100.0/24\"\n ],\n \"allow_access_to_client_functions\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{clients_url}}/addApiKey","description":"

Add API key

This endpoint is used to create a new API key

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: PUT
\n
URL:{{clients_url}/addApiKey
\n
Headers:
\n
- x-api-key : Your API key
\n
Body
\n
- key_name : (string) a name for this API key
  \n
- key_usage : (string) shopify (key for shopify integration), zapier (key for zapier integration), custom (key for anythign else)
  \n
- allow_access_to_client_functions : (boolean) 1=Key can be used to manage client data (users, keys etc.) (Only applicable if key_sage is \"custom\")
  \n
- ip_allow_list : (array) of CIDR ranges. (Only applicable is key_usage is \"custom\")
  \n
\n

{\n  \"key_name\": \"my new custom API key\",\n  \"key_usage\": \"custom\",\n  \"ip_allow_list\": [\n    \"203.0.113.10\",\n    \"198.51.100.0/24\"\n  ],\n  \"allow_access_to_client_functions\": 0\n}\n\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body
\n
- key_id : (integer) ID of the new key pair
\n

{\n    \"key_id\": 64,\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["addApiKey"],"host":["{{clients_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"08cdf77b-2702-452e-a87e-8cc59ffbfd37"},{"name":"Set API Key Status","id":"e5ab25d2-d7ee-41fe-b7c3-fdcbf68d6764","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{clients_url}}/setApiKeyStatus/:key_id/:status/:allow_access_to_client_functions","description":"

Set API key status

This endpoint is used to enabled/disable an API key

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: PATCH
\n
URL: {{client_url}}/setApiKeyStatus.:key_id/:status/:admin_status
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- key_id (string): The ID of the key.
  \n
- status (string): status - \"enabled\" or \"disabled\"
  \n
- allow_access_to_client_functions (string): status - \"enabled\" or \"disabled\"
  \n
\n

Response

Status: 200
\n
Content-Type: application/json
\n

{\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["setApiKeyStatus",":key_id",":status",":allow_access_to_client_functions"],"host":["{{clients_url}}"],"query":[],"variable":[{"id":"0f587cec-4250-4738-ada0-4e56ed30fa26","description":{"content":"

API Key ID

\n","type":"text/plain"},"type":"any","value":"60","key":"key_id"},{"id":"e943f4e3-ad24-437c-899a-50cfeac97a31","description":{"content":"

enabled | disabled

\n","type":"text/plain"},"type":"any","value":"enabled","key":"status"},{"id":"93ef61e4-decf-47c2-92ae-5d852b999e03","description":{"content":"

enabled | disabled

\n","type":"text/plain"},"type":"any","value":"enabled","key":"allow_access_to_client_functions"}]}},"response":[],"_postman_id":"e5ab25d2-d7ee-41fe-b7c3-fdcbf68d6764"},{"name":"Delete API Key","id":"3d34476d-db28-43c4-842c-2b6db9879252","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"url":"{{clients_url}}/deleteApiKey/:key_id","description":"

Delete API key

This endpoint is used to delete an API key

NOTE: You need an API key with client admin permission enabled to use thos function.

Request

Method: DELETE
\n
URL: {{clients_url}}/deleteApiKey/:key_id
\n
Headers:
\n
- x-api-key : Your API key
\n
Path Parameters:
\n
- key_id (string): The ID of the key to be deleted.
\n

Response

Status: 200
\n
Content-Type: application/json
\n

{\n    \"ok\": true\n}\n\n

\n","urlObject":{"path":["deleteApiKey",":key_id"],"host":["{{clients_url}}"],"query":[],"variable":[{"id":"8c575353-3ecd-41a5-bd75-6ae8fd198531","type":"any","value":"65","key":"key_id"}]}},"response":[],"_postman_id":"3d34476d-db28-43c4-842c-2b6db9879252"},{"name":"get Client Data","id":"eac57fe9-337a-49c7-9620-6d9fea0dc09d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{clients_url}}/getClientDetails","description":"

Get Client Data

This endpoint is used to retrieve data relating to your client account

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: GET
\n
URL: {{clients_url}}/getClientData
\n
Headers:
\n
- x-api-key : Your API key
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- client : (object)
\n

{\n    \"client\": {\n        \"address\": \"Your street\\nYour town\\nPostcode\",\n        \"billing_day_of_month\": 15,\n        \"billing_email\": \"user1@null.com\",\n        \"billing_mode\": \"prepay\",\n        \"billing_period\": 4,\n        \"client_enabled\": 1,\n        \"client_id\": 2,\n        \"company_number\": \"123\",\n        \"creation_date\": \"20251020\",\n        \"deletion_date\": null,\n        \"main_contact_email\": \"user2@null.com\",\n        \"main_contact_name\": \"User Two\",\n        \"main_contact_phone\": \"01234567890\",\n        \"max_active_passes\": 75,\n        \"name\": \"Your client name\",\n        \"next_tariff_tier\": null,\n        \"tariff_name\": \"Standard\",\n        \"tariff_tier\": \"FREE\",\n        \"vat_number\": null\n    },\n    \"ok\": true\n}\n\n

","urlObject":{"path":["getClientDetails"],"host":["{{clients_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eac57fe9-337a-49c7-9620-6d9fea0dc09d"},{"name":"get Invoices","id":"b6f71075-e163-4c7d-a2f4-e09145a48dee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{api_key}}","description":"

API access key

\n","type":"text"}],"url":"{{clients_url}}/getInvoices/:start_date","description":"

Get invoices

This endpoint is used to retrieve data your past invoices.

Payment for invoices is normally taken automatically either by payment card or direct debit.

NOTE: You need an API key with client admin permission enabled to use this function.

Request

Method: GET
\n
URL: {{clients_url}}/getInvoices
\n
Headers:
\n
- x-api-key : Your API key
\n

Response

Status: 200
\n
Content-Type: application/json
\n
Body:
\n
- invoices : (array)
  \n
  - client_id : (integer) Your client ID
    \n
  - accounts_client_id : (integer) Your alternative client ID in our accounts system
    \n
  - clientName : (string) your name
    \n
  - clientAddress : (string) your address
    \n
  - invoice_date : (ISOdate) :date invoice raised
    \n
  - date_due : (satestring) : date payment due
    \n
  - amount : (numeric) Total amount (ex VAT)
    \n
  - vat : (numeric) VAT amount
    \n
  - total : (numeric) VAT inclusive total (amount due)
    \n
  - payment_error : (string) If a payment failes this will contain erro rinformation
    \n
  - details : (array)
    \n
    - details : (string) Item being charged for
      \n
    - id : (interger) IS in our accounts system
      \n
    - amount : (numeric) amount (ex VAT)
      \n
    - vat : (numeric) VAT amount
      \n
    \n
  \n
- variables : (object) Our bank details etc.
  \n
\n

{\n    \"invoices\": [\n        {\n            \"accounts_client_id\": 4,\n            \"amount\": 12,\n            \"clientAddress\": \"Your address\\nYour town\\nPosrtcode\",\n            \"clientName\": \"Your client name\",\n            \"client_id\": 20,\n            \"date_paid\": \"20250923\",\n            \"details\": [\n                {\n                    \"amount\": 6,\n                    \"details\": \"4000 active passes [1-4000] @ £0.0015\",\n                    \"id\": 51,\n                    \"vat\": 1.2\n                },\n                {\n                    \"amount\": 6,\n                    \"details\": \"6000 active passes [4000-10000] @ £0.001\",\n                    \"id\": 50,\n                    \"vat\": 1.2\n                }\n            ],\n            \"due_date\": \"20250922\",\n            \"invoice_date\": \"2025-09-15\",\n            \"invoice_id\": 21,\n            \"invoicenumber\": \"M250900000021\",\n            \"payment_error\": null,\n            \"total\": 14.4,\n            \"vat\": 2.4\n        }\n    ],\n    \"ok\": true,\n    \"variables\": {\n        \"bankAccountName\": \"Smartix Ltd\",\n        \"companyAddress\": \"93 Guillemot Road\\nPortishead\\nBristol\\nBS20 7PG\",\n        \"companyEmail\": \"admin@smartix.uk\",\n        \"companyName\": \"Smartix Ltd\",\n        \"companyNumber\": \"15903189\",\n        \"invoiceAccountNumber\": \"40494912\",\n        \"invoiceSortCode\": \"60-83-71\",\n        \"invoiceTerms\": \"Payment within 14 days of invoice date\",\n        \"remittanceAddress\": \"At the above address\",\n        \"vatNumber\": \"awaiting registration\"\n    }\n}\n\n

","urlObject":{"path":["getInvoices",":start_date"],"host":["{{clients_url}}"],"query":[],"variable":[{"id":"6fd88e04-1f87-4648-9221-a4f65f8cf775","type":"any","value":"20250901","key":"start_date"}]}},"response":[],"_postman_id":"b6f71075-e163-4c7d-a2f4-e09145a48dee"}],"id":"70f670d7-d04c-4e29-9836-32472f1a3355","description":"

Functions relating to managing users and API keys

\n","_postman_id":"70f670d7-d04c-4e29-9836-32472f1a3355"},{"name":"Device API","item":[{"name":"Get apple pass","id":"4ed36c6c-921a-42b8-bb9f-bf181f7a608c","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"vnd.apple.pkpass","type":"text"}],"url":"{{devices_url}}/pkpass/:jwttoken","description":"

Get Apple pass

When you create a pass you receive an apple_url in the response. That url points at this endpoint.

This endpoint is documente dfor completeness. You should not use this directly to obtain the pk pass to pass onto your users, you shoudl supply them with the url so they can install direfly onto their devices.

Request

Method: GET
\n
URL: {{devices_url}}/pkpass/:jwttoken
\n

Response

Status: 200
\n
Content-Type: application/pkpass
\n
Body : Apple PK Pass data
\n

\n","urlObject":{"path":["pkpass",":jwttoken"],"host":["{{devices_url}}"],"query":[],"variable":[{"id":"9fc40565-1d43-4051-b1ad-aeebd1d4faf0","type":"any","value":"","key":"jwttoken"}]}},"response":[],"_postman_id":"4ed36c6c-921a-42b8-bb9f-bf181f7a608c"},{"name":"Get apple passes","id":"4670d9a9-c5e8-476c-80b1-c55ccd191332","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"vnd.apple.pkpasses"}],"url":"{{devices_url}}/pkpasses/:jwttoken","description":"

Get Apple passes

When you create a group of passes (makePasses) you receive an apple_url in the response. That url points at this endpoint.

Request

Method: GET
\n
URL: {{devices_url}}/pkpasses/:jwttoken
\n

Response

Status: 200
\n
Content-Type: application/pkpasses
\n
Body : Apple PK Pass data bundle
\n

\n","urlObject":{"path":["pkpasses",":jwttoken"],"host":["{{devices_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"jwttoken"}]}},"response":[],"_postman_id":"4670d9a9-c5e8-476c-80b1-c55ccd191332"}],"id":"225ee2e4-01c0-4ad9-aa2b-a835890a912c","description":"

End points for installing Apple passes

\n","_postman_id":"225ee2e4-01c0-4ad9-aa2b-a835890a912c"}],"event":[{"listen":"prerequest","script":{"id":"074992d9-be98-462b-8ea7-8acb999096c6","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"a84e0f22-ee2e-466e-9a9b-a404e7575254","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}]}