Get Member

Get Member

curl --request GET \
  --url https://api.decodahealth.com/inventory/members/{member_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "id": "<string>",
  "patientId": "<string>",
  "membershipId": "<string>",
  "membership": {
    "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
  },
  "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>"
  },
  "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
  },
  "logs": [
    {
      "id": "<string>",
      "logType": "STATUS_CHANGE",
      "createdDate": "2023-11-07T05:31:56Z"
    }
  ]
}

GET

inventory

members

{member_id}

Get Member

curl --request GET \
  --url https://api.decodahealth.com/inventory/members/{member_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "id": "<string>",
  "patientId": "<string>",
  "membershipId": "<string>",
  "membership": {
    "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
  },
  "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>"
  },
  "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
  },
  "logs": [
    {
      "id": "<string>",
      "logType": "STATUS_CHANGE",
      "createdDate": "2023-11-07T05:31:56Z"
    }
  ]
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Path Parameters

member_id

string

required

Response

Successful Response

string

required

Unique identifier for the member

patientId

string

required

ID of the patient

membershipId

string

required

ID of the membership

membership

MembershipDetail · object

required

Membership information

Show child attributes

membership.name

string

required

Name of the membership

membership.price

integer

required

Price of the membership in cents

membership.id

string

Unique identifier for the membership

membership.externalId

string | null

External system identifier for the membership

membership.description

string | null

Optional description of the membership

membership.globalDiscountPercentage

number | null

default:0

Global discount percentage for all items

membership.patientCreditAmount

integer

default:0

Amount of patient credit in cents

membership.patientCreditFrequency

enum<string>

default:MONTHLY

Frequency of patient credit

Available options:

DAILY,

WEEKLY,

BIWEEKLY,

MONTHLY,

QUARTERLY,

SEMI_ANNUALLY,

YEARLY

membership.patientCreditExpiryDays

integer | null

Days until patient credit expires

membership.maxRenewals

integer | null

default:0

Maximum number of renewals (null means unlimited)

membership.autoRenew

boolean

default:true

Whether the membership auto-renews

membership.setupFee

integer

default:0

Setup fee for the membership in cents

membership.freezeFee

integer

default:0

Fee to freeze the membership in cents

membership.minimumBillingCycles

integer

default:0

Minimum number of billing cycles required

membership.billingFrequency

enum<string>

default:MONTHLY

Billing frequency for the membership

Available options:

DAILY,

WEEKLY,

BIWEEKLY,

MONTHLY,

QUARTERLY,

SEMI_ANNUALLY,

YEARLY

membership.textColor

string | null

Text color for the membership

membership.isArchived

boolean

default:false

Whether the membership is archived

membership.ruleSetId

string | null

ID of the rule set for the membership

membership.discounts

MembershipDiscount · object[] | null

Optional discounts for the membership

Show child attributes

membership.discounts.membershipId

string

required

ID of the membership this discount belongs to

membership.discounts.id

string

Unique identifier for the membership discount

membership.discounts.itemId

string | null

ID of the specific item for this discount (includes packages)

membership.discounts.itemCategory

string | null

Category name for items in this discount (references category.name)

membership.discounts.isPhysical

boolean | null

Whether this discount applies to physical items (True), services (False), or neither (None)

membership.discounts.discountPercentage

number | null

Discount percentage

membership.discounts.discountAmount

integer | null

Discount amount in cents

membership.discounts.creditAmount

integer | null

Credit amount in cents

membership.discounts.quantity

integer | null

Quantity for this discount

membership.discounts.rollover

boolean

default:false

Whether to rollover unused quantities

membership.discounts.rolloverExpiryDays

integer | null

Days until rollover items expire

membership.discounts.neverExpire

boolean

default:false

Whether rollover items never expire

membership.discounts.group

string | null

Group for this discount

membership.discounts.isArchived

boolean

default:false

Whether the discount is archived

membership.memberCount

integer | null

default:0

Number of active members

membership.totalRevenue

integer | null

default:0

Total revenue from this membership

startDate

string<date-time>

required

When the patient joined the membership

status

enum<string>

required

Current status of the membership

Available options:

ACTIVE,

EXPIRED,

CANCELLED,

DELINQUENT,

FROZEN

autoRenew

boolean

required

Whether the membership auto-renews

billingFrequency

enum<string>

required

Billing frequency for this member

Available options:

DAILY,

WEEKLY,

BIWEEKLY,

MONTHLY,

QUARTERLY,

SEMI_ANNUALLY,

YEARLY

patient

PatientSummary · object

required

Patient information

Show child attributes

patient.id

string

required

The unique identifier for the user.

patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

patient.createdDate

string<date-time>

required

The date and time when the user was created.

patient.firstName

string | null

The user's first name.

patient.lastName

string | null

The user's last name.

patient.phoneNumber

string | null

The user's phone number.

patient.email

string | null

The user's email address.

patient.locationId

string | null

The location of the user.

patient.externalId

string | null

The user's external identifier if available.

patient.address

string | null

The user's primary address.

patient.addressLineTwo

string | null

Additional address information.

patient.city

string | null

The city of the user's address.

patient.state

string | null

The state of the user's address.

patient.zipCode

string | null

The postal code of the user's address.

patient.country

string | null

The country of the user's address.

patient.addressValid

boolean | null

Whether the user's address is valid.

patient.meta

Meta · object

Any additional metadata about the user relevant to your system.

patient.isArchived

boolean | null

Whether the user is archived.

patient.primaryLocationId

string | null

The primary location of the user.

patient.gender

string | null

The gender of the patient.

patient.dateOfBirth

string<date> | null

The date of birth of the patient.

patient.patientMedications

string[] | null

List of patient's self-reported medications.

patient.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

patient.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

patient.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

patient.tags.id

string

required

Unique identifier for the patient tag

patient.tags.name

string

required

Name of the patient tag

patient.tags.isActive

boolean

required

Whether the tag is active

patient.tags.createdDate

string<date-time>

required

Date and time when the tag was created

patient.tags.emoji

string | null

Emoji associated with the tag

patient.tags.color

string | null

Color code for the tag (hex format)

patient.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

patient.creditBalance

integer | null

Patient's credit balance in cents.

patient.preferredProviderId

string | null

The preferred provider ID for this patient.

charges

ChargeTiny · object[]

required

Charges for this member

Show child attributes

charges.id

string

required

Unique identifier for the charge.

charges.patientId

string

required

Identifier of the patient being charged.

soldByProviderId

string | null

ID of the provider who sold this membership

endDate

string<date-time> | null

When the membership ended (if applicable)

nextBillingDate

string<date-time> | null

Next scheduled billing date (if custom)

unfreezeDate

string<date-time> | null

When the membership should be automatically unfrozen

soldByProvider

ProviderCreator · object

Provider who sold this membership

Show child attributes

soldByProvider.id

string

required

soldByProvider.firstName

string

required

soldByProvider.lastName

string | null

createdDate

string<date-time> | null

When the member record was created

updatedDate

string<date-time> | null

When the member record was last updated

paymentMethod

PaymentMethodSummary · object

Payment method for this member

Show child attributes

paymentMethod.id

string

required

paymentMethod.patientId

string | null

required

paymentMethod.rainforestPaymentMethodId

string

required

paymentMethod.brand

string | null

required

paymentMethod.last4

string | null

required

paymentMethod.expMonth

integer | null

required

paymentMethod.expYear

integer | null

required

paymentMethod.accountHolderType

string | null

required

paymentMethod.accountNumberLast4

integer | null

required

paymentMethod.bankName

string | null

required

paymentMethod.routingNumber

integer | null

required

paymentMethod.description

string | null

required

paymentMethod.type

enum<string> | null

required

Available options:

CARD,

ACH,

APPLE_PAY

paymentMethod.isDefault

boolean

default:false

paymentMethod.isArchived

boolean

default:false

logs

MemberLogTiny · object[]

Activity logs for this member

Show child attributes

logs.id

string

required

Unique identifier for the log

logs.logType

enum<string>

required

Type of log

Available options:

STATUS_CHANGE,

MANUAL_PAYMENT,

RENEWED,

PAYMENT_METHOD_CHANGE,

DISCOUNT_USED,

DISCOUNT_RESTORED,

DISCOUNT_MODIFIED,

ENROLLED,

BILLING_DATE_CHANGE

logs.createdDate

string<date-time>

required

When the log was created

Get Item Brand Names Get Member Logs

⌘I

Getting Started

API

Tenant

Webhook

Headers

Path Parameters

Response