Skip to main content

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​

GoalStart here
Sign members into another applicationOAuth overview
Connect a XenForo forumXenForo setup
Read or update organisation dataAPI-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​

  1. Create an API key in RemyPass with the permissions your integration needs.
  2. Send the key in the X-API-Key header.
  3. Use GET /pass-templates to find the passTemplateId you want to issue.
  4. Create or find a member.
  5. 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​

ResourceDescription
MembersPeople in your organisation who can receive passes.
Pass templatesConfigured pass designs and pass types available for issuing.
Pass instancesIssued wallet passes linked to a member or recipient.
Event ticketsEvent-specific passes created from booking and customer details.
Memberships and membership typesMembership records, billing state and available tiers.
ScansRecorded member and pass scans.
Events, registrations and ordersEvent configuration, attendees and ticket purchase records.
Donations, subscriptions and campaignsFundraising payments, recurring giving and campaigns.
Webhook subscriptionsEvent 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.