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

Activate membership

Request

Activate membership

Path
tenantIdstringrequired

The id of the tenant being accessed.

application_idstringrequired

The contact id

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

Responses

The members was retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring

Execute Batch Operations

Request

TAllows you to perform up to 100 parallel patch/delete operations

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/memberships/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects
success_countnumber(float)(Success Count)

Number of successful results

Response
application/json
{ "error_count": 0.1, "results": [ {} ], "success_count": 0.1 }

Downloads a Certificate

Request

Returns the HTML for the certificate

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}/certificate/{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"

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