Skip to content
Membership
/
/
Gets a membership by cont...

Gets a membership by contact

Request

Gets a membership by contact

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

contactIdstringrequired

The contact id

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/memberships/{tenantId}/contact/{contactId}' \
  -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
Bodyapplication/json
add_on_idsArray of strings(Add Ons)

used for reporting, DO NOT UPLOAD DATA HERE

add_on_namesstring(Add On Names)

Read only: Show the name of the add ons to this membership

add_onsArray of objects
application_idstring(Application)

The last application

application_process_idstring(Application Process)

The last application process

assigned_membershipsArray of objects

Memberships that have been assigned, manually, by organization administrators

bill_methodstring(Bill Method)

The method this member was billed

Enum:"auto renewal order""renewal notice""renewal order"
bill_organizationboolean(Bill Organization)

Whether or not to bill the organization for this membership

billedboolean(Billed)

Flag indicated whether the membership has been billed

certificate_uristring(Certificate Uri)

A link to an externally created certificate of membership

chapter_idsArray of strings(Chapter IDs)

used for reporting, DO NOT UPLOAD DATA HERE

chapter_namesstring(Chapter Names)

Read only: Show the name of the chapters to which a person belongs

chaptersArray of objects
citystring(City)

The member city

contact_idstring(Contact)required

The owner of this membership

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)
customer_idstring(Customer)

For reporting only; the contact ID if this is owned by a contact, the organization if this is owned by an organization

date_last_updated_in_portalstring, (date-time)(Date Last Updated In Portal)

The date that this was last updated in the portal

date_statusstring(Date Status)

Whether the dates have been updated

Enum:"not yet updated""updated"
directory_image_uristring(Directory Image Uri)

The image that appears in the membership directory

do_not_dropboolean(Do Not Drop)

If set, this membership will not be dropped/terminated along lifecycle rules

do_not_renewboolean(Do Not Renew)

If so, this membership will not renew

do_not_show_in_directoryboolean(Do Not Show In Directory)

If set, the membership is not available in the directory

email_addressstring(Email Address)

The member's email address

expiration_datestring(Expiration Date)

The date the membership expires

first_namestring(First Name)

The member's first name

flowdown_depthnumber, (float), [ 1 .. 10 ](Flowdown Depth)required

If this is a flow down membership, the depth

hidden_directory_fieldsArray of strings(Hidden Directory Fields)

The fields that should not be shown for this member in the directory

historyArray of objects

The history of membership events & activities

idstring(ID)^[\w-|:]+$required

The unique, string identifier of this membership

is_newboolean(Is New)

Whether or not this is a new membership

job_titlestring(Job Title)

The member job title

join_datestring(Join Date)

The date the member joined

join_or_last_renewal_datestring(Join Or Last Renewal Date)

The date the member joined OR renewed

lapse_datestring(Lapse Date)

The last date that this record was terminated. Unlike termination date does not get erased

last_bill_datestring, (date-time)(Last Bill Date)

The last time this order was billed

last_change_affiliation_datestring, (date-time)(Last Change Affiliation Date)

The last date a change affiliation was run on this membership

last_expired_card_warningnumber, (float)(Last Expired Card Warning)

The last expired card warning

last_expired_card_warning_datestring, (date-time)(Last Expired Card Warning Date)

The last time a reminder was sent

last_namestring(Last Name)

The member's last name

last_remindernumber, (float)(Last Reminder)

The last reminder number

last_reminder_datestring, (date-time)(Last Reminder Date)

The last time a reminder was sent

master_membership_idstring(Master Membership)

The master organizational membership that generates the flowdown; when depth=1 this is the same as the parent, but supports cascading membership

master_membership_organization_idstring(Master Membership Organization)

The master organization that owns the membership; when depth=1 this is the same as the parent, but supports cascading membership

membership_join_datestring(Membership Join Date)

Reporting only; used to avoid collisions

namestring(Name)required

The member's name

notesstring(Notes)
numbernumber, (float)(Number)required

The unique membership number

order_amount_paidnumber, (double)(Order Amount Paid)

The amount paid

order_balance_duenumber, (double)(Order Balance Due)

The balance due on the order

order_currency_codestring(Order Currency Code)
order_currency_symbolstring(Order Currency Symbol)
order_idstring(Order)

The order

order_line_item_idstring(Order Line Item)

The order line item

order_numbernumber, (float)(Order Number)

The order number

order_statusstring(Order Status)
Enum:"awaiting payment""awaiting pickup""awaiting shipping""cancelled""completed""disputed""open""partially shipped""returned""shipped"
order_totalnumber, (double)(Order Total)

The total of the order

organization_idstring(Organization)required

The organizational owner of this membership

originstring(Origin)
Enum:"assigned""flowdown""principal"
overridden_fieldsArray of strings(Overridden Fields)

Fields that have been changed on this record, and should not be susceptible to flowdown

owner_typestring(Owner Type)required

The type of owner

Enum:"contact""organization"
package_idstring(Package)required

The package id of the membership

parent_membership_idstring(Parent Membership)organization:.*required

The parent organization

past_chapter_membershipsArray of objects
past_section_membershipsArray of objects
primary_chapter_idstring(Primary Chapter)

The chapter ID (used for reporting, DO NOT UPLOAD DATA HERE

referral_contact_idstring(Referral Contact)

The individual who referred this member

reinstatement_datestring(Reinstatement Date)

The date the member was last reinstated

renew_automaticallyboolean(Renew Automatically)

If set, then this membership will automatically renew with the card on file

renewal_currency_codestring(Renewal Currency Code)

The currency code to use for renewal

Enum:"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
renewal_datestring(Renewal Date)

The date the member last renewed

renewal_payment_card_expirationstring, (date)(Renewal Payment Card Expiration)

The date that the renewal payment card expires

renewal_payment_infoobject(Renewal Payment Info)required

The renewal payment info

section_idsArray of strings(Section IDs)

used for reporting, DO NOT UPLOAD DATA HERE

section_namesstring(Section Names)

Read only: Show the name of the sections to which a person belongs

sectionsArray of objects
statestring(State)

The state

statusstring(Status)

The member status

Enum:"active""active without benefits""inactive""suspended"
status_reason_idstring(Status Reason)

The reason that a member is in the specific status

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber, (float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring, (date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring, (date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber, (float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber, (float)(Sys Version)

A number representing the version of this record in the database

term_start_datestring(Term Start Date)

The date the most recently purchased membership type starts

termination_datestring(Termination Date)

The date the member was terminated

type_idstring(Type)required

The type of member

Response
{
  "add_on_ids": [
    "string"
  ],
  "add_on_names": "string",
  "add_ons": [
    { … }
  ],
  "application_id": "string",
  "application_process_id": "string",
  "assigned_memberships": [
    { … }
  ],
  "bill_method": "auto renewal order",
  "bill_organization": true,
  "billed": true,
  "certificate_uri": "string",
  "chapter_ids": [
    "string"
  ],
  "chapter_names": "string",
  "chapters": [
    { … }
  ],
  "city": "string",
  "contact_id": "string",
  "country": "string",
  "custom_field_values": [
    { … }
  ],
  "customer_id": "string",
  "date_last_updated_in_portal": "2019-08-24T14:15:22Z",
  "date_status": "not yet updated",
  "directory_image_uri": "string",
  "do_not_drop": true,
  "do_not_renew": true,
  "do_not_show_in_directory": true,
  "email_address": "string",
  "expiration_date": "string",
  "first_name": "string",
  "flowdown_depth": 1,
  "hidden_directory_fields": [
    "string"
  ],
  "history": [
    { … }
  ],
  "id": "string",
  "is_new": true,
  "job_title": "string",
  "join_date": "string",
  "join_or_last_renewal_date": "string",
  "lapse_date": "string",
  "last_bill_date": "2019-08-24T14:15:22Z",
  "last_change_affiliation_date": "2019-08-24T14:15:22Z",
  "last_expired_card_warning": 0.1,
  "last_expired_card_warning_date": "2019-08-24T14:15:22Z",
  "last_name": "string",
  "last_reminder": 0.1,
  "last_reminder_date": "2019-08-24T14:15:22Z",
  "master_membership_id": "string",
  "master_membership_organization_id": "string",
  "membership_join_date": "string",
  "name": "string",
  "notes": "string",
  "number": 0.1,
  "order_amount_paid": 0.1,
  "order_balance_due": 0.1,
  "order_currency_code": "string",
  "order_currency_symbol": "string",
  "order_id": "string",
  "order_line_item_id": "string",
  "order_number": 0.1,
  "order_status": "awaiting payment",
  "order_total": 0.1,
  "organization_id": "string",
  "origin": "assigned",
  "overridden_fields": [
    "string"
  ],
  "owner_type": "contact",
  "package_id": "string",
  "parent_membership_id": "string",
  "past_chapter_memberships": [
    { … }
  ],
  "past_section_memberships": [
    { … }
  ],
  "primary_chapter_id": "string",
  "referral_contact_id": "string",
  "reinstatement_date": "string",
  "renew_automatically": true,
  "renewal_currency_code": "AED",
  "renewal_date": "string",
  "renewal_payment_card_expiration": "2019-08-24",
  "renewal_payment_info": {
    "card_expiration": "string",
    "card_type": "american express",
    "merchant_account_tokens": [ … ],
    "payment_account": "string",
    "payment_origin": "ad hoc",
    "token": "string",
    "type": "credit card"
  },
  "section_ids": [
    "string"
  ],
  "section_names": "string",
  "sections": [
    { … }
  ],
  "state": "string",
  "status": "active",
  "status_reason_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "term_start_date": "string",
  "termination_date": "string",
  "type_id": "string"
}