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

Get eligible application processes

Request

Path
tenantIdstringrequired

Parameters to the query

chapterIdstringrequired

The chapter ID

contactIdstringrequired

The contact ID

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/chapters/{tenantId}/portal/getEligibleAppProcesses/{chapterId}/{contactId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Processes were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
object
Response
application/json
{}

Get portal permissions

Request

Determines the permissions available in the portal for a portal user.

Path
tenantIdstringrequired

The tenant

chapterIdstringrequired

The chapter id

contactIdstringrequired

The contact id

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/chapters/{tenantId}/portalPermissions/{chapterId}/{contactId}' \
  -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
access_saved_queriesboolean(Access Saved Queries)

If set, the applicable chapter leaders are able to access saved queries

chapter_page_layout_idstring(Chapter Page Layout)
contact_form_idstring(Contact Form)
manage_chapter_committeesboolean(Manage Chapter Committees)

If set, leaders can manage/change chapter committee positions

membership_page_layout_idstring(Membership Page Layout)
permissionsArray of strings(Permissions)

A list of permissions by name

renew_existing_membersboolean(Renew Existing Members)

If set, leaders can renew existing members

saved_queriesArray of objects
sign_up_new_membersboolean(Sign Up New Members)

Applicable chapter leaders can register/create new members

update_chapter_infoboolean(Update Chapter Info)

If true, chapter leader is able to modify chapter information

update_contact_infoboolean(Update Contact Info)

Applicable chapter leaders should be able to update contact information. If set, a contact_form_id must be specified

update_membership_infoboolean(Update Membership Info)

Applicable chapter leaders can update membership profile information. If set, a membership_page_layout_id must be specified

view_chapter_rosterboolean(View Chapter Roster)

If set, the applicable chapter leaders can see the committee roster and view membership information

Response
application/json
{ "access_saved_queries": true, "chapter_page_layout_id": "string", "contact_form_id": "string", "manage_chapter_committees": true, "membership_page_layout_id": "string", "permissions": [ "string" ], "renew_existing_members": true, "saved_queries": [ {} ], "sign_up_new_members": true, "update_chapter_info": true, "update_contact_info": true, "update_membership_info": true, "view_chapter_roster": true }

Runs a saved query on behalf of a chapter

Request

Path
tenantIdstringrequired

Parameters to the query

chapterIdstringrequired

The saved query ID

savedQueryIdstringrequired

The saved query ID

outputFormatstringrequired

The output format of the query

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

Responses

The contact was merged successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
object
Response
application/json
{}

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

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