Get Member

Get a member's details.

get/inventory/members/{member_id}

Request

Base URL
https://docs.decodahealth.com (the document declares no server; this is the origin it was published from)
Auth
none declared. Required headers: TENANT, API-KEY
TypeScript
https://skmtc.dev/decodahealth/apis/decoda-api/docs/inventory/members/:member_id/get.ts
A function with typed inputs. Its response is checked against the schema.

member_idstring required

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Successful Response

idstring required

Unique identifier for the member

patientIdstring required

ID of the patient

membershipIdstring required

ID of the membership

soldByProviderIdstring nullable

ID of the provider who sold this membership

startDatestring date-time required

When the patient joined the membership

endDatestring date-time nullable

When the membership ended (if applicable)

nextBillingDatestring date-time nullable

Next scheduled billing date (if custom)

unfreezeDatestring date-time nullable

When the membership should be automatically unfrozen

status'ACTIVE' | 'EXPIRED' | 'CANCELLED' | 'DELINQUENT' | 'FROZEN' required

autoRenewboolean required

Whether the membership auto-renews

createdDatestring date-time nullable

When the member record was created

updatedDatestring date-time nullable

When the member record was last updated

No recorded changes to this operation across all 2 revisions of this API.