let you create, manage, organize and distribute digital Passes to mobile devices.

GitHub repository

All the sample code is hosted on GitHub.

If you have any suggestions or feature requests, please create a new issue.


If you want to familiarize with the APIs before subscribing, you can use the Sandbox available at The only thing that chages is the subdomain. Accounts in the production website and in the sandbox are not linked in any way.

The Sandbox will be periodically erased, so keep in mind that when performing your tests. There isn't any way to keep your Templates and Passes there.



Resource Description
GET /api/v1/analytics Get all analytics
GET /api/v1/analytics/created Get analytics for created passes
GET /api/v1/analytics/redeemed Get analytics for redeemed passes
GET /api/v1/analytics/installed Get analytics for installed passes


Resource Description
GET /api/v1/campaigns Get all campaigns
GET /api/v1/campaigns/:id Show a campaign
POST /api/v1/campaigns Create a Campaign
PUT /api/v1/campaigns/:id Update Campaign
DELETE /api/v1/campaigns/:id Delete List
POST /api/v1/campaigns/deliver Deliver Campaign
GET /api/v1/campaigns/kinds Campaign kinds


Resource Description
GET /api/v1/certificates Show available Certificates


Resource Description
GET /api/v1/templates/:template_id/passes/:id/devices Show Devices for a Pass


Resource Description
GET /api/v1/templates Get All Templates
GET /api/v1/templates/:id Show Template
POST /api/v1/templates Create Template
PUT /api/v1/templates/:template_id Update Template
DELETE /api/v1/templates/:id Delete Template
GET /api/v1/templates/:id/fields Get Editable Fields


Resource Description
GET /api/v1/lists Get all lists
GET /api/v1/lists/:id Show a list
POST /api/v1/lists Create a List
PUT /api/v1/lists/:id Update List
DELETE /api/v1/lists/:id Delete List


Resource Description
GET /api/v1/templates/:template_id/passes Get All Passes
GET /api/v1/templates/:template_id/passes/:id Show Pass
POST /api/v1/templates/:template_id/passes Create Pass
PUT /api/v1/templates/:template_id/passes/:id Update Pass
PUT /api/v1/templates/:template_id/passes/:id/redeem Redeem a Pass
DELETE /api/v1/templates/:template_id/passes/:id Delete Pass
GET /api/v1/templates/:template_id/passes/search Search for a Pass
GET /api/v1/passes/search Search for a Pass by the 2D code in every Template owned by the User


Resource Description
GET /api/v1/people Get People list
GET /api/v1/people/:id Show a Person
POST /api/v1/people Create a Person
PUT /api/v1/people/:id Update Person
DELETE /api/v1/people/:id Delete Person
GET /api/v1/people/fields Get available fields


Resource Description
POST /api/v1/registrations Create User


Resource Description
POST /api/v1/sessions Authenticate User