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

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
{}

View chapter roster

Request

Allows for a portal user to view the roster

Path
tenantIdstringrequired

The tenant

chapterIdstringrequired

The chapter id

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/chapters/{tenantId}/roster/{chapterId}?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
ItemsArray of objects
LastEvaluatedKeystring
Response
application/json
{ "Items": [ {} ], "LastEvaluatedKey": "string" }

Searches for chapters using predefined parameters

Request

Searches for chapters using predefined parameters

Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

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

Bodyapplication/jsonrequired

The chapter that you would like to be saved.

citystring(City)

City to search

idArray of strings(ID)

IDs to search

is_activeArray of booleans(Is Active)
namestring(Name)
statestring(State)

The state

type_idArray of strings(Type)

Types to search

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/chapters/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "city": "string",
    "id": [
      "string"
    ],
    "is_active": [
      true
    ],
    "name": "string",
    "state": "string",
    "type_id": [
      "string"
    ]
  }'

Responses

The chapter search was saved successfully.

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

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