Membership (v1-2025-04-18)

The Membership API provides all the capabilities for managing your membership. Although it is most commonly used to look up the membership information for a single contact or organization, it can also be used to approve, modify, or drop members.

Like most of the other Rhythm apps, the Membership API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/
https://membership.api.rhythmsoftware.com/

Add On Products

Add On Products

Operations

Add On Types

Add On Types

Operations

Add Ons

Add Ons

Operations

App Reference Types

App Reference Types

Operations

Application Groups

Application Groups

Operations

Application Processes

Application Processes

Operations

Application Status Reasons

Application Status Reasons

Operations

Applications

Applications

Operations

Ballots

Ballots

Operations

Billing Notices

Billing Notices

Operations

Billing Run Actions

Billing Run Actions

Operations

Billing Runs

Billing Runs

Operations

Billing Templates

Billing Templates

Operations

Change Fees

Change Fees

Operations

Chapter Dues Products

Chapter Dues Products

Operations

Chapter Types

Chapter Types

Operations

Chapters

Chapters

Operations

Coupons

Coupons

Operations

Directories

Directories

Operations

Elections

Elections

Operations

Group Application Processes

Group Application Processes

Operations

Id Card Templates

Id Card Templates

Operations

Memberships

Memberships

Operations

Generates a PDF for the ID Card and returns the public link for download

Request

Generates a PDF for the ID Card and returns the public link for download

Path
tenantIdstringrequired

The id of the tenant being accessed

idstringrequired

The ID of the membership

Query
downloadAsHtmlboolean

If true, return the receipt as HTML

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/memberships/{tenantId}/idCard/{id}?downloadAsHtml=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The membership was downloaded successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
string
Response
application/json
"string"

Generates snapshot lookback for a tenant

Request

Given a set of expiration options, allows for the calculation of an expiration date

Path
tenantIdstringrequired

The id of the tenant being accessed.

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/memberships/{tenantId}/initiateSnapshotLookback' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Date was calculated successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
string
Response
application/json
"string"

Returns a list of records with the specified order_id

Request

Returns a list of records with the specified order_id

Path
tenantIdstringrequired

The tenant

order_idstringrequired

The order_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/memberships/{tenantId}/order/{order_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(Membership)
LastEvaluatedKeystring
Response
application/json
{ "Count": 0, "Items": [ {} ], "LastEvaluatedKey": "string" }

Packages

Packages

Operations

Query Definitions

Query Definitions

Operations

Recurring Billing Runs

Recurring Billing Runs

Operations

Section Dues Products

Section Dues Products

Operations

Section Types

Section Types

Operations

Sections

Sections

Operations

Settings

Settings

Operations

Statistics

Statistics

Operations

Status Reasons

Status Reasons

Operations

Types

Types

Operations