API Documentation Sign In
The Union, International Union Against Tuberculosis and Lung Disease logo

One API for Union membership.

Check whether someone is a member, sync people into the membership system and generate paid memberships from your own systems. JSON over REST, authenticated with OAuth2 client credentials.

Base URL
api.theunion.org/api/v1
Auth
OAuth2 client credentials
Staging
api-staging.theunion.org
Format
JSON requests and responses

Explore the endpoints

Pick a route to see a sample request and response. Switch environment to update the URLs. Every route except the token and membership-valid calls needs a bearer token; full field lists are in the API documentation.

Two portals, one platform

Test member journeys in the Membership portal and staff operations in the Manager portal.

Membership

membership.theunion.org

The member-facing site for joining, renewing, paying fees and using benefits.

  • Join and renew
  • Fees and donations
  • Groups
  • Journals
  • Events and recordings
  • Gift membership
Open Membership

Manager

manager.theunion.org

The staff-facing site for support teams and day-to-day membership management.

  • Member records
  • Support actions
  • Membership management
  • Reporting workflows
Open Manager

Go live in three steps

Test against staging first, then switch the base URL.

  1. Request a clientAsk for a client ID and secret for each environment, then exchange them at /oauth/token for a bearer token.
  2. Test on stagingCall api-staging.theunion.org. Use "dry_run": true on membership-generate to validate without creating anything.
  3. Switch to productionSwap the base URL to api.theunion.org and use your production client. Routes and response shapes stay the same.