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.
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/memberships/{tenantId}/previewIdCard/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"id_card_template": "string",
"membership_id": "string"
}'curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/memberships/{tenantId}/reprocessFlowDown' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"notification_email": "string"
}'"string"
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/memberships/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"city": "string",
"email_address": "string",
"expiration_date": [
"2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"id": [
"string"
],
"is_new": "string",
"job_title": "string",
"join_date": [
"2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"name": "string",
"number": [
0.1,
0.1
],
"origin": [
"string"
],
"owner_type": "string",
"package_id": [
"string"
],
"renewal_date": [
"2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"state": "string",
"status": [
"string"
],
"status_reason_id": [
"string"
],
"termination_date": [
"2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"type_id": [
"string"
]
}'{ "Items": [ { … } ], "LastEvaluatedKey": "string" }