Get Membership Analytics List

curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/memberships/list \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "membership_ids": [],
  "member_statuses": [],
  "location_ids": [],
  "sold_by_provider_ids": []
}
'

{
  "data": [
    {
      "id": "<string>",
      "patientId": "<string>",
      "membershipId": "<string>",
      "membership": {
        "id": "<string>",
        "name": "<string>",
        "textColor": "<string>"
      },
      "startDate": "2023-11-07T05:31:56Z",
      "status": "ACTIVE",
      "autoRenew": true,
      "billingFrequency": "DAILY",
      "patient": {
        "id": "<string>",
        "type": "PROVIDER",
        "createdDate": "2023-11-07T05:31:56Z",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>",
        "externalId": "<string>",
        "address": "<string>",
        "addressLineTwo": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>",
        "addressValid": true,
        "meta": {},
        "isArchived": true,
        "primaryLocationId": "<string>",
        "gender": "<string>",
        "dateOfBirth": "2023-12-25",
        "patientMedications": [
          "<string>"
        ],
        "onSchedulingBlacklist": true,
        "surchargeDisabled": true,
        "tags": [
          {
            "id": "<string>",
            "name": "<string>",
            "isActive": true,
            "createdDate": "2023-11-07T05:31:56Z",
            "emoji": "<string>",
            "color": "<string>",
            "updatedDate": "2023-11-07T05:31:56Z"
          }
        ],
        "creditBalance": 123,
        "preferredProviderId": "<string>",
        "primaryLocation": {
          "id": "<string>",
          "name": "<string>",
          "isVirtual": true
        }
      },
      "charges": [
        {
          "id": "<string>",
          "patientId": "<string>"
        }
      ],
      "soldByProviderId": "<string>",
      "endDate": "2023-11-07T05:31:56Z",
      "nextBillingDate": "2023-11-07T05:31:56Z",
      "unfreezeDate": "2023-11-07T05:31:56Z",
      "soldByProvider": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "paymentMethod": {
        "id": "<string>",
        "patientId": "<string>",
        "rainforestPaymentMethodId": "<string>",
        "brand": "<string>",
        "last4": "<string>",
        "expMonth": 123,
        "expYear": 123,
        "accountHolderType": "<string>",
        "accountNumberLast4": 123,
        "bankName": "<string>",
        "routingNumber": 123,
        "description": "<string>",
        "type": "CARD",
        "isDefault": false,
        "isArchived": false
      }
    }
  ],
  "total": 123
}

GET

analytics

dashboards

memberships

list

Get Membership Analytics List

curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/memberships/list \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "membership_ids": [],
  "member_statuses": [],
  "location_ids": [],
  "sold_by_provider_ids": []
}
'

{
  "data": [
    {
      "id": "<string>",
      "patientId": "<string>",
      "membershipId": "<string>",
      "membership": {
        "id": "<string>",
        "name": "<string>",
        "textColor": "<string>"
      },
      "startDate": "2023-11-07T05:31:56Z",
      "status": "ACTIVE",
      "autoRenew": true,
      "billingFrequency": "DAILY",
      "patient": {
        "id": "<string>",
        "type": "PROVIDER",
        "createdDate": "2023-11-07T05:31:56Z",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>",
        "externalId": "<string>",
        "address": "<string>",
        "addressLineTwo": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>",
        "addressValid": true,
        "meta": {},
        "isArchived": true,
        "primaryLocationId": "<string>",
        "gender": "<string>",
        "dateOfBirth": "2023-12-25",
        "patientMedications": [
          "<string>"
        ],
        "onSchedulingBlacklist": true,
        "surchargeDisabled": true,
        "tags": [
          {
            "id": "<string>",
            "name": "<string>",
            "isActive": true,
            "createdDate": "2023-11-07T05:31:56Z",
            "emoji": "<string>",
            "color": "<string>",
            "updatedDate": "2023-11-07T05:31:56Z"
          }
        ],
        "creditBalance": 123,
        "preferredProviderId": "<string>",
        "primaryLocation": {
          "id": "<string>",
          "name": "<string>",
          "isVirtual": true
        }
      },
      "charges": [
        {
          "id": "<string>",
          "patientId": "<string>"
        }
      ],
      "soldByProviderId": "<string>",
      "endDate": "2023-11-07T05:31:56Z",
      "nextBillingDate": "2023-11-07T05:31:56Z",
      "unfreezeDate": "2023-11-07T05:31:56Z",
      "soldByProvider": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "paymentMethod": {
        "id": "<string>",
        "patientId": "<string>",
        "rainforestPaymentMethodId": "<string>",
        "brand": "<string>",
        "last4": "<string>",
        "expMonth": 123,
        "expYear": 123,
        "accountHolderType": "<string>",
        "accountNumberLast4": 123,
        "bankName": "<string>",
        "routingNumber": 123,
        "description": "<string>",
        "type": "CARD",
        "isDefault": false,
        "isArchived": false
      }
    }
  ],
  "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

location_ids

string[]

membership_ids

string[]

member_statuses

string[]

sold_by_provider_ids

string[]

location

string | null

membership

string | null

status

string | null

sold_by_provider

string | null

page

integer | null

per_page

integer | null

sort_by

string | null

sort_direction

enum<string> | null

Available options:

asc,

desc

location_id

string | null

patient_name

string | null

created_date_start

string<date-time> | null

created_date_end

string<date-time> | null

start_date_start

string<date-time> | null

start_date_end

string<date-time> | null

next_billing_date_start

string<date-time> | null

next_billing_date_end

string<date-time> | null

timezone

string

default:UTC

Body

application/json

membership_ids

string[]

member_statuses

enum<string>[]

Available options:

ACTIVE,

EXPIRED,

CANCELLED,

DELINQUENT,

FROZEN

location_ids

string[]

sold_by_provider_ids

string[]

Response

Successful Response

data

MemberAnalyticsSummary · object[]

required

Show child attributes

data.id

string

required

Unique identifier for the member

data.patientId

string

required

ID of the patient

data.membershipId

string

required

ID of the membership

data.membership

MembershipTiny · object

required

Membership information

Show child attributes

data.membership.id

string

required

Unique identifier for the membership

data.membership.name

string

required

Name of the membership

data.membership.textColor

string | null

Text color of the membership

data.startDate

string<date-time>

required

When the patient joined the membership

data.status

enum<string>

required

Current status of the membership

Available options:

ACTIVE,

EXPIRED,

CANCELLED,

DELINQUENT,

FROZEN

data.autoRenew

boolean

required

Whether the membership auto-renews

data.billingFrequency

enum<string>

required

Billing frequency for this member

Available options:

DAILY,

WEEKLY,

BIWEEKLY,

MONTHLY,

QUARTERLY,

SEMI_ANNUALLY,

YEARLY

data.patient

PatientSummaryWithLocation · object

required

Patient information with location

Show child attributes

data.patient.id

string

required

The unique identifier for the user.

data.patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.patient.createdDate

string<date-time>

required

The date and time when the user was created.

data.patient.firstName

string | null

The user's first name.

data.patient.lastName

string | null

The user's last name.

data.patient.phoneNumber

string | null

The user's phone number.

data.patient.email

string | null

The user's email address.

data.patient.locationId

string | null

The location of the user.

data.patient.externalId

string | null

The user's external identifier if available.

data.patient.address

string | null

The user's primary address.

data.patient.addressLineTwo

string | null

Additional address information.

data.patient.city

string | null

The city of the user's address.

data.patient.state

string | null

The state of the user's address.

data.patient.zipCode

string | null

The postal code of the user's address.

data.patient.country

string | null

The country of the user's address.

data.patient.addressValid

boolean | null

Whether the user's address is valid.

data.patient.meta

Meta · object

Any additional metadata about the user relevant to your system.

data.patient.isArchived

boolean | null

Whether the user is archived.

data.patient.primaryLocationId

string | null

The primary location of the user.

data.patient.gender

string | null

The gender of the patient.

data.patient.dateOfBirth

string<date> | null

The date of birth of the patient.

data.patient.patientMedications

string[] | null

List of patient's self-reported medications.

data.patient.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

data.patient.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

data.patient.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

data.patient.tags.id

string

required

Unique identifier for the patient tag

data.patient.tags.name

string

required

Name of the patient tag

data.patient.tags.isActive

boolean

required

Whether the tag is active

data.patient.tags.createdDate

string<date-time>

required

Date and time when the tag was created

data.patient.tags.emoji

string | null

Emoji associated with the tag

data.patient.tags.color

string | null

Color code for the tag (hex format)

data.patient.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

data.patient.creditBalance

integer | null

Patient's credit balance in cents.

data.patient.preferredProviderId

string | null

The preferred provider ID for this patient.

data.patient.primaryLocation

LocationTinyWithName · object

Primary location of the patient

Show child attributes

data.patient.primaryLocation.id

string

required

data.patient.primaryLocation.name

string

required

data.patient.primaryLocation.isVirtual

boolean

required

data.charges

ChargeTiny · object[]

required

Charges for this member

Show child attributes

data.charges.id

string

required

Unique identifier for the charge.

data.charges.patientId

string

required

Identifier of the patient being charged.

data.soldByProviderId

string | null

ID of the provider who sold this membership

data.endDate

string<date-time> | null

When the membership ended (if applicable)

data.nextBillingDate

string<date-time> | null

Next scheduled billing date (if custom)

data.unfreezeDate

string<date-time> | null

When the membership should be automatically unfrozen

data.soldByProvider

ProviderCreator · object

Provider who sold this membership

Show child attributes

data.soldByProvider.id

string

required

data.soldByProvider.firstName

string

required

data.soldByProvider.lastName

string | null

data.createdDate

string<date-time> | null

When the member record was created

data.updatedDate

string<date-time> | null

When the member record was last updated

data.paymentMethod

PaymentMethodSummary · object

Payment method for this member

Show child attributes

data.paymentMethod.id

string

required

data.paymentMethod.patientId

string | null

required

data.paymentMethod.rainforestPaymentMethodId

string

required

data.paymentMethod.brand

string | null

required

data.paymentMethod.last4

string | null

required

data.paymentMethod.expMonth

integer | null

required

data.paymentMethod.expYear

integer | null

required

data.paymentMethod.accountHolderType

string | null

required

data.paymentMethod.accountNumberLast4

integer | null

required

data.paymentMethod.bankName

string | null

required

data.paymentMethod.routingNumber

integer | null

required

data.paymentMethod.description

string | null

required

data.paymentMethod.type

enum<string> | null

required

Available options:

CARD,

ACH,

APPLE_PAY

data.paymentMethod.isDefault

boolean

default:false

data.paymentMethod.isArchived

boolean

default:false

total

integer

required

Get Membership Analytics Groups Get Notes Breakdown

⌘I

Getting Started

API

Tenant

Webhook

Get Membership Analytics List

Headers

Query Parameters

Body

Response