Developer Resources

eMembership REST API

Comprehensive API for managing contacts, memberships, subscriptions, transactions, payments, invoices, and events programmatically.

Get Started View Endpoints
RESTful
Standard REST API
7
Core Resources
JSON
Request & Response
OAuth 2.0
Secure Authentication

Getting Started

The eMembership API provides programmatic access to all core membership management functionality. Built on REST principles, it uses standard HTTP methods and returns JSON responses.

Base URL

https://api.emembership.org/v1/

Authentication

All API requests require authentication using OAuth 2.0 Bearer tokens:

Authorization: Bearer YOUR_ACCESS_TOKEN
API Key Required

To access the API, you need to generate API credentials from your eMembership dashboard under Settings → API Access.

API Resources

Seven core resources provide complete control over your membership data

Contacts

/contacts

Manage individual and organizational contacts with full CRUD operations. Store personal information, addresses, phone numbers, emails, and custom fields.

Endpoints:
  • GET /contacts
  • GET /contacts/{id}
  • POST /contacts
  • PUT /contacts/{id}
  • DELETE /contacts/{id}
Key Features:
  • Search & filtering
  • Bulk operations
  • Custom fields
  • Merge contacts

Memberships

/memberships

Create and manage membership records, tiers, statuses, start/end dates, and renewal tracking. Link memberships to contacts and handle upgrades/downgrades.

Endpoints:
  • GET /memberships
  • GET /memberships/{id}
  • POST /memberships
  • PUT /memberships/{id}
  • POST /memberships/{id}/renew
Key Features:
  • Membership tiers
  • Status tracking
  • Auto-renewal settings
  • Grace periods

Subscriptions

/subscriptions

Manage recurring billing subscriptions with flexible intervals (monthly, quarterly, annual). Control auto-renewal, billing cycles, and subscription pauses.

Endpoints:
  • GET /subscriptions
  • GET /subscriptions/{id}
  • POST /subscriptions
  • PUT /subscriptions/{id}
  • POST /subscriptions/{id}/cancel
Key Features:
  • Billing intervals
  • Auto-renewal control
  • Proration handling
  • Pause/resume

Transactions

/transactions

Record and track all financial transactions including payments, refunds, credits, and adjustments. Complete transaction history with audit trails.

Endpoints:
  • GET /transactions
  • GET /transactions/{id}
  • POST /transactions
  • POST /transactions/{id}/refund
Key Features:
  • Transaction types
  • Refund processing
  • Audit trails
  • Date filtering

Payments

/payments

Process payments via multiple methods (credit card, direct debit, bank transfer). Track payment status, failed payments, and payment methods.

Endpoints:
  • GET /payments
  • GET /payments/{id}
  • POST /payments
  • POST /payments/{id}/retry
Key Features:
  • Multiple methods
  • Payment status
  • Failed payment retry
  • PCI compliance

Invoices

/invoices

Generate, send, and manage invoices. Track invoice status (draft, sent, paid, overdue), apply payments, and generate PDF documents.

Endpoints:
  • GET /invoices
  • GET /invoices/{id}
  • POST /invoices
  • PUT /invoices/{id}
  • POST /invoices/{id}/send
Key Features:
  • Invoice generation
  • Status tracking
  • PDF export
  • Email delivery

Events

/events

Create and manage events, registrations, tickets, and attendees. Track capacity, pricing tiers, and attendance.

Endpoints:
  • GET /events
  • GET /events/{id}
  • POST /events
  • PUT /events/{id}
  • GET /events/{id}/registrations
Key Features:
  • Event management
  • Registration tracking
  • Ticket types
  • Attendance lists

Quick Start Examples

Get up and running with these simple code examples

List All Contacts

GET https://api.emembership.org/v1/contacts
Authorization: Bearer YOUR_ACCESS_TOKEN

// Response
{
  "data": [
    {
      "id": "contact_123456",
      "first_name": "John",
      "last_name": "Smith",
      "email": "john.smith@example.com",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 1250
  }
}

Create a New Membership

POST https://api.emembership.org/v1/memberships
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "contact_id": "contact_123456",
  "membership_tier": "premium",
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "auto_renew": true
}

Process a Payment

POST https://api.emembership.org/v1/payments
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "contact_id": "contact_123456",
  "amount": 99.00,
  "currency": "GBP",
  "payment_method": "card",
  "description": "Annual membership fee"
}

API Features

High Performance

Fast response times with rate limiting and caching for optimal performance.

Secure & Compliant

OAuth 2.0 authentication, encryption at rest and in transit, GDPR compliant.

Well Documented

Comprehensive documentation with examples in multiple programming languages.

Versioned

API versioning ensures backward compatibility and smooth upgrades.

Webhooks

Real-time event notifications via webhooks for instant updates.

Developer Support

Dedicated developer support and active community forums.

Ready to Get Started?

Contact our team to get your API credentials and start building today

Get in Touch View Pricing