Skip to main content
GET
/
inventory
/
memberships
List Memberships
curl --request GET \
  --url https://api.decodahealth.com/inventory/memberships \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "name": "<string>",
      "price": 123,
      "id": "<string>",
      "externalId": "<string>",
      "description": "<string>",
      "globalDiscountPercentage": 0,
      "patientCreditAmount": 0,
      "patientCreditFrequency": "MONTHLY",
      "patientCreditExpiryDays": 123,
      "maxRenewals": 0,
      "autoRenew": true,
      "setupFee": 0,
      "freezeFee": 0,
      "minimumBillingCycles": 0,
      "billingFrequency": "MONTHLY",
      "textColor": "<string>",
      "isArchived": false,
      "ruleSetId": "<string>",
      "discounts": [
        {
          "membershipId": "<string>",
          "id": "<string>",
          "itemId": "<string>",
          "itemCategory": "<string>",
          "isPhysical": true,
          "discountPercentage": 123,
          "discountAmount": 123,
          "creditAmount": 123,
          "quantity": 123,
          "rollover": false,
          "rolloverExpiryDays": 123,
          "neverExpire": false,
          "group": "<string>",
          "isArchived": false
        }
      ],
      "memberCount": 0,
      "totalRevenue": 0
    }
  ],
  "total": 123
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

name
string | null

Filter by membership name

price_min
integer | null

Minimum price filter

price_max
integer | null

Maximum price filter

is_archived
boolean | null

Filter by archived status

page
integer
default:1

Page number

per_page
integer
default:25

Items per page

Response

Successful Response

data
MembershipDetail · object[]
required
total
integer
required