v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the details of all the members of a center

This API helps you to retrieve the list of memebers in the specified center.

You must specify the unique identifier of the center as center_id in the API request. You can also leverage the pagination feature by passing page and size query parameters if you have a large number of records to be displayed. By default, page is set as 1 and size is set as 10. size cannot be more than 100: which means that the maximum records per page cannot be more than 100.

get/v1/centers/{center_id}/members?status={status}&created_date={date}&last_updated_date={date}&page={page}&size={size}

Path parameters

center_idstring required

Mandatory Unique 32-character identifier of the center.

Query parameters

created_datestring date

Optional Date on which the membership was created.

last_updated_datestring date

Optional Date on which the membership was last updated.

pageinteger

Optional Number of the display page. Default value is 1.

sizeinteger

Optional Number of records per page. Default value is 10.

status''

Optional Indicates the status of the membership: all - -1, active - 1, inactive - 2, frozen - 3, cancelled - 4, expired - 5, closed - 6, not_started - 7, suspended - 8, refund - 9, deleted - 10, failed - 12.

Response

200

Example response

{
  "members": [
    {
      "id": "f902bdb9-b127-4dab-b628-87715eed12b6",
      "status": "active",
      "guest": {
        "id": "5b2a4f2a-489b-45bf-9fc7-b2d413c2870b",
        "name": "Kirity Owner"
      },
      "membership": {
        "id": "eb424feb-e60f-472b-a9b0-effc17663e75",
        "code": "mem_test",
        "name": "mem_test",
        "type": "Recurring",
        "version_id": "5901deec-f98d-44d6-b81b-02c8265d6356"
      },
      "start_date": "2019-05-15T00:00:00",
      "end_date": "2020-05-14T00:00:00",
      "sold_date": "2020-05-14T00:00:00",
      "renewal_details": {
        "id": "eb424feb-e60f-472b-a9b0-effc17663e75",
        "auto_renewal": true
      },
      "credits_amount": 50
    }
  ],
  "page_info": {
    "total": 30,
    "page": 1,
    "size": 10
  }
}