Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Membership

Search Memberships

Search a list of Memberships.

get/memberships/search

Query parameters

qstring required

Search query. See the Search section for guidance on how to build a query.

sortstring

Specifies the order in which the list will be returned. Default order is ascending. Default sort attribute is Id. Specify desc_ to sort descending format: "sort=desc_snake_cased_attribute_name" OR "sort=snake_cased_attribute_name" ex. sort=desc_updated_on

pageinteger

Specifies the page of records to be returned. Defaults to 1.

page_sizeinteger

Number of records to return per page. Maximum and default are 100 records.

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Web Integrations screen.

Response

List of Memberships

Example response

{
  "memberships": [
    {
      "id": 1234567891234567,
      "client_id": 1234567891234567,
      "membership_template_id": 1234567891234567,
      "renewed_from_membership_id": 1234567891234567,
      "location_of_sale_id": 1234567891234567,
      "start_date": "2014-12-31",
      "end_date": "2014-12-31",
      "attendance_limit_type_id": 1234567891234567,
      "expiration_type_id": 1234567891234567,
      "expiration_date": "2014-12-31",
      "original_expiration_date": "2014-12-31",
      "revenue_category_id": 1234567891234567,
      "membership_contract_template_id": 1234567891234567,
      "contract_signed_on_date": "2014-12-31T23:59:59.938Z",
      "tax_rate_id": 1234567891234567,
      "tax_rate": 0.1,
      "service_id": 1234567891234567,
      "service_duration_id": 1234567891234567,
      "payment_plan": {
        "payment_plan_id": 1234567891234567,
        "payment_plan_template_id": 1234567891234567,
        "auto_renew_stop_date": "2014-12-31",
        "initial_payment_option": {
          "initial_payment_option_id": 1234567891234567,
          "initial_payment_option_template_id": 1234567891234567,
          "initial_payment_option_type_id": 1234567891234567,
          "initial_cost": 0.1,
          "initial_setup_fee": 0.1
        },
        "renewal_payment_option": {
          "renewal_payment_option_id": 1234567891234567,
          "renewal_payment_option_template_id": 1234567891234567,
          "renewal_payment_option_type_id": 1234567891234567,
          "renewal_cost": 0.1
        }
      },
      "scheduled_deactivation_date": "2014-12-31",
      "created": {
        "created_by_id": 1234567891234567,
        "created_on_datetime": "2014-12-31T23:59:59.938Z"
      },
      "updated": {
        "updated_by_id": 1234567891234567,
        "updated_on_datetime": "2014-12-31T23:59:59.938Z"
      }
    }
  ]
}