Overview
RemyPass Developer Hub covers member sign-in with OAuth and API-key authenticated member and wallet pass workflows. Use it to connect external systems, sign members into a forum, issue Apple Wallet and Google Wallet passes, manage pass lifecycle events, and create event tickets from booking data.
Choose Your Integration
| Goal | Start here |
|---|---|
| Sign members into another application | OAuth overview |
| Connect a XenForo forum | XenForo setup |
| Read or update organisation data | API-key authentication |
What You Can Build
- Sync members from a CRM, ticketing platform, membership system, or data warehouse.
- Create and update members, including organisation-defined custom fields.
- Issue wallet passes to existing members.
- Set and update pass expiry dates.
- Revoke, reinstate, and resend pass delivery emails.
- Discover available pass templates before issuing passes.
- Create event tickets from booking and customer details.
- Read memberships, membership types, scans, events, ticket orders, registrations and fundraising records.
- Provision webhook subscriptions and inspect, test or replay deliveries.
Base URL
Business data requests use the public API base path:
https://api.remypass.com/api/v1/public
OAuth sign-in uses separate endpoints under /api/v1/oauth.
Principles
- API key authentication for business data endpoints
- Scoped permissions per API key
- Tenant-bound access to company data
- Consistent JSON response envelopes
- Rate-limited and auditable requests
- OpenAPI reference documentation
Quick Start
- Create an API key in RemyPass with the permissions your integration needs.
- Send the key in the
X-API-Keyheader. - Use
GET /pass-templatesto find thepassTemplateIdyou want to issue. - Create or find a member.
- Issue a pass, or create a member with
issuePass: true.
Example:
curl -X GET "https://api.remypass.com/api/v1/public/members?limit=10&page=1" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"
Core Resources
| Resource | Description |
|---|---|
| Members | People in your organisation who can receive passes. |
| Pass templates | Configured pass designs and pass types available for issuing. |
| Pass instances | Issued wallet passes linked to a member or recipient. |
| Event tickets | Event-specific passes created from booking and customer details. |
| Memberships and membership types | Membership records, billing state and available tiers. |
| Scans | Recorded member and pass scans. |
| Events, registrations and orders | Event configuration, attendees and ticket purchase records. |
| Donations, subscriptions and campaigns | Fundraising payments, recurring giving and campaigns. |
| Webhook subscriptions | Event selection, delivery history, testing and replay. |
Common Workflows
Create a Member and Issue a Pass
Use POST /members with issuePass: true, passTemplateId, and optionally expiryDate. The member is created first, then RemyPass attempts to issue the pass.
Issue a Pass to an Existing Member
Use POST /passes/issue with the member _id and passTemplateId. You can include customFields, expiryDate, and sendEmail.
Manage Pass Lifecycle
Use the pass lifecycle endpoints to:
- Void a pass with revoke; voided passes cannot be reinstated.
- Reinstate an inactive pass.
- Update or remove a pass expiry date.
- Send or resend the pass email.
Response Format
Public API business data responses use a consistent JSON envelope. OAuth endpoints return direct OAuth JSON instead.
{
"success": true,
"message": "Members retrieved successfully",
"data": [],
"pagination": {
"currentPage": 1,
"totalPages": 1,
"totalItems": 0,
"itemsPerPage": 10,
"hasNextPage": false,
"hasPrevPage": false
}
}
Where to Go Next
- Read Authentication to learn how API keys work.
- Read Authorization and Permissions to choose key scopes.
- Read Querying for pagination and filters.
- Use the Endpoint Reference for request fields, response fields, and examples.