--- title: "Get Memberships" method: GET path: "/memberships" tags: ["Membership"] --- # Get Memberships `GET /memberships` Get a list of Memberships. ## Query parameters - `sort` string - `page` integer - `page_size` integer ## Headers - `x-api-key` string, required ## Response `200` List of Memberships - ResponseMemberships — List of Memberships - `memberships` MembershipsAPI[] — Membership Data - `id` integer, required — Identifies the Membership. - `client_id` integer, required — Identifies the Client that has this particular membership. - `name` string — Name of the Membership. - `membership_template_id` integer, required — Identifies the Template associated with this Membership. - `renewed_from_membership_id` integer — If this Membership was a renewal, identifies the Membership from which it was renewed. - `has_been_renewed` boolean — Has the membership been renewed? - `location_of_sale_id` integer — Identifies the Location of sale. - `location_of_sale` string — Name of the Location of sale. - `start_date` string, date — The Membership start date. - `end_date` string, date — End Date of the Membership. - `membership_type_id` integer — Identifies the Membership type. - `membership_type` string — Name of the Membership type. - `attendance_type_id` integer — Identifies the Membership attendance type. - `attendance_type` string — Name of the attendance type. - `attendance_limit` integer — Attendance limit. - `attendance_limit_frequency` integer — The frequency/number of days that the class attendance limit applies to. - `attendance_limit_type_id` integer — Identifies the attendance limit type. - `attendance_limit_type` string — Name of the attendance limit type. - `number_of_sessions` integer — Number of sessions. - `sessions_already_used` integer — Only for use on a new session plan, if the plan is being created but the Client already has used some sessions. - `does_membership_expire` boolean — Determines if the membership expires. Only applicable to Class Packs - `expiration_type_id` integer — Identifies the expiration type. - `expiration_type` string — Name of the expiration type. - `expiration_length` integer — The Membership expiration length. - `expiration_date` string, date — The Membership expiration date. - `original_expiration_date` string, date — Date on which the Membership originally expired. - `revenue_category_id` integer — Identifies the revenue category for this Membership. - `revenue_category` string — Name of the revenue category. - `membership_contract_template_id` integer — Identifies the Membership Contract template. - `contract_name` string — Name of the Membership Contract. - `contract_signed_on_date` string, date-time — Date on which the Contract was signed. - `tax_rate_id` integer — Identifies the tax rate. - `tax_rate_name` string — Name of the tax rate. - `tax_rate` number — Rate of tax. - `is_absorbing_fees` boolean — Indicates if this particular Membership should ignore any environment settings about passing on administrative fees. - `service_id` integer — The Service Id of the Membership for Appointment Packs - `service` string — The Service of the Membership for Appointment Packs - `service_duration_id` integer — Id of the Duration for the Service on an Appointment Pack Membership - `service_duration_hours` integer — The hours of the Service duration for Appointment Pack Memberships - `service_duration_minutes` integer — The minutes of the Service duration for Appointment Pack Memberships - `payment_plan` PaymentPlansAPI — Payment Plan Data - `payment_plan_id` integer, required — Payment Plan Id - `payment_plan_template_id` integer — Identifies the Payment Plan Template used for this Payment Plan. - `payment_plan_name` string — Name of the Payment Plan - `is_auto_renew` boolean — Indicates if the Membership is set to auto-renew. - `auto_renew_stop_date` string, date — Date on which auto renew should be paused. - `is_deactivate_user_on_auto_renew_stop_date` boolean — Is deactivated user on auto renew pause? - `billing_day_id` integer — Identifies the Billing Day of the PaymentPlan. - `billing_day` string — Billing Day name - `initial_payment_interval_time_unit_id` integer — Initial Payment Time Unit Interval Id - `initial_payment_interval_time_unit` string — Name of the initial payment interval time unit. - `initial_payment_interval_length` integer — Length of the Initial Payment. - `initial_commitment_time_unit_id` integer — Id of the Initial Commitment Time Unit - `initial_commitment_time_unit` string — Name of the Initial Commitment Time Unit. - `initial_commitment_length` integer — Length of the Initial Commitment. - `initial_payment_option` InitialPaymentOptionAPI — Initial Payment Option Data - `initial_payment_option_id` integer, required — Initial Payment Option Id. - `initial_payment_option_template_id` integer — Id of the Initial Payment Option Template from the Payment Plan Template - `initial_payment_option_type_id` integer — Id of the Initial Payment Option Type. - `initial_payment_option_type` string — Name of the Initial Payment Option Type. - `initial_cost` number — Initial cost. - `initial_setup_fee` number — Initial setup fee. - `renewal_payment_interval_time_unit_id` integer — Identifies the renewal payment interval time unit. - `renewal_payment_interval_time_unit` string — Name of the renewal payment interval time unit. - `renewal_payment_interval_length` integer — Renewal payment interval length. - `renewal_commitment_time_unit_id` integer — Identifies the renewal commitment time unit. - `renewal_commitment_time_unit` string — Name of the renewal commitment time unit. - `renewal_commitment_length` integer — Renewal commitment length. - `renewal_payment_option` RenewalPaymentOptionAPI — Renewal Payment Option Data - `renewal_payment_option_id` integer, required — Renewal Payment Option Id - `renewal_payment_option_template_id` integer — Id of the Renewal Payment Option Template from the Payment Plan Template - `renewal_payment_option_type_id` integer — Id of the Renewal Payment Option Type - `renewal_payment_option_type` string — Name of the Renewal Payment Option Type - `renewal_cost` number — Renewal cost - `has_scheduled_deactivation` boolean — Indicates if the membership has a scheduled date to be deactivated - `scheduled_deactivation_date` string, date — Date on which a membership has been scheduled to deactivate - `allow_rollover` boolean — When true, can use rollover sessions. - `rollover_sessions` integer — The count of sessions rolled over from previous membership/limited period. Only applies to limited plan memberships. - `max_total_sessions` integer — The maximum number of sessions that can be used in a booking period (attendance limitation + rollover). Only applies to limited plan memberships. When value is 0, no limit exists. - `is_active` boolean, required — Indicates if the Membership is active. - `is_deleted` boolean — Determines if the Membership was deleted - `created` Created — Record creation data. - `created_by_id` integer — Unique ID of the user that created the record. - `created_by` string — Name of the user that created the record. - `created_on_datetime` string, date-time — Datetime on which the record was created. - `updated` Updated — Update info - `updated_by_id` integer — Unique ID of the user that last updated the record. - `updated_by` string — Name of the user that most recently updated the record. - `updated_on_datetime` string, date-time — Datetime on which the record was last updated. - `pagination` Pagination — Pagination for API method responses. - `page` integer, required — Current page number. - `page_size` integer, required — Number of records per page. - `has_more` boolean, required — True if more records exist beyond the current page. --- [API](https://skmtc.net/wodify/apis/leads.md) · [All operations](https://skmtc.net/wodify/apis/leads/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wodify/leads/revisions/974500ca0714/schema)