--- title: "Get Membership Analytics List" method: GET path: "/analytics/dashboards/memberships/list" tags: ["provider", "analytics"] --- # Get Membership Analytics List `GET /analytics/dashboards/memberships/list` ## Request - Base URL: `https://docs.decodahealth.com` (the document declares no server; this is the origin it was published from) - URL: `https://docs.decodahealth.com/analytics/dashboards/memberships/list` - Auth: none declared. Required headers: `TENANT`, `API-KEY` - TypeScript: (a function with typed inputs; its response is checked against the schema) Get member analytics with filters. ## Query parameters - `location_ids` string[] - `membership_ids` string[] - `member_statuses` string[] - `sold_by_provider_ids` string[] - `location` string, nullable - `membership` string, nullable - `status` string, nullable - `sold_by_provider` string, nullable - `page` integer, nullable - `per_page` integer, nullable - `sort_by` string, nullable - `sort_direction` 'asc' | 'desc', nullable - `location_id` string, nullable - `patient_name` string, nullable - `created_date_start` string, date-time, nullable - `created_date_end` string, date-time, nullable - `start_date_start` string, date-time, nullable - `start_date_end` string, date-time, nullable - `next_billing_date_start` string, date-time, nullable - `next_billing_date_end` string, date-time, nullable - `timezone` string ## Headers - `TENANT` string, required - `API-KEY` string, required ## Request body - BodyGetMembershipAnalyticsListAnalyticsDashboardsMembershipsListGet - `membership_ids` string[] - `member_statuses` MemberStatus[] - `location_ids` string[] - `sold_by_provider_ids` string[] ## Response `200` Successful Response - PageMemberAnalyticsSummary - `data` MemberAnalyticsSummary[], required - `id` string, required: Unique identifier for the member - `patientId` string, required: ID of the patient - `membershipId` string, required: ID of the membership - `membership` MembershipTiny, required - `id` string, required: Unique identifier for the membership - `name` string, required: Name of the membership - `textColor` string, nullable: Text color of the membership - `soldByProviderId` string, nullable: ID of the provider who sold this membership - `startDate` string, date-time, required: When the patient joined the membership - `endDate` string, date-time, nullable: When the membership ended (if applicable) - `nextBillingDate` string, date-time, nullable: Next scheduled billing date (if custom) - `unfreezeDate` string, date-time, nullable: When the membership should be automatically unfrozen - `status` 'ACTIVE' | 'EXPIRED' | 'CANCELLED' | 'DELINQUENT' | 'FROZEN', required - `autoRenew` boolean, required: Whether the membership auto-renews - `billingFrequency` 'DAILY' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'YEARLY', required - `patient` PatientSummaryWithLocation, required: Patient summary with primary location details for analytics. - `id` string, required: The unique identifier for the user. - `firstName` string, nullable: The user's first name. - `lastName` string, nullable: The user's last name. - `phoneNumber` string, nullable: The user's phone number. - `email` string, nullable: The user's email address. - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required - `locationId` string, nullable: The location of the user. - `externalId` string, nullable: The user's external identifier if available. - `address` string, nullable: The user's primary address. - `addressLineTwo` string, nullable: Additional address information. - `city` string, nullable: The city of the user's address. - `state` string, nullable: The state of the user's address. - `zipCode` string, nullable: The postal code of the user's address. - `country` string, nullable: The country of the user's address. - `createdDate` string, date-time, required: The date and time when the user was created. - `addressValid` boolean, nullable: Whether the user's address is valid. - `meta` object, nullable: Any additional metadata about the user relevant to your system. - `isArchived` boolean, nullable: Whether the user is archived. - `primaryLocationId` string, nullable: The primary location of the user. - `gender` string, nullable: The gender of the patient. - `dateOfBirth` string, date, nullable: The date of birth of the patient. - `patientMedications` string[], nullable: List of patient's self-reported medications. - `onSchedulingBlacklist` boolean, nullable: Whether the patient is on the scheduling blacklist. - `surchargeDisabled` boolean, nullable: Whether surcharges are disabled for this patient. - `tags` PatientTagSummary[], nullable: List of patient tags - `id` string, required: Unique identifier for the patient tag - `name` string, required: Name of the patient tag - `emoji` string, nullable: Emoji associated with the tag - `color` string, nullable: Color code for the tag (hex format) - `isActive` boolean, required: Whether the tag is active - `createdDate` string, date-time, required: Date and time when the tag was created - `updatedDate` string, date-time, nullable: Date and time when the tag was last updated - `creditBalance` integer, nullable: Patient's credit balance in cents. - `preferredProviderId` string, nullable: The preferred provider ID for this patient. - `primaryLocation` LocationTinyWithName: Location with name for analytics - avoids requiring eager loading everywhere. - `id` string, required - `name` string, required - `isVirtual` boolean, required - `charges` ChargeTiny[], required: Charges for this member - `id` string, required: Unique identifier for the charge. - `patientId` string, required: Identifier of the patient being charged. - `soldByProvider` ProviderCreator - `id` string, required - `firstName` string, required - `lastName` string, nullable - `createdDate` string, date-time, nullable: When the member record was created - `updatedDate` string, date-time, nullable: When the member record was last updated - `paymentMethod` PaymentMethodSummary - `id` string, required - `patientId` string, nullable, required - `rainforestPaymentMethodId` string, required - `brand` string, nullable, required - `last4` string, nullable, required - `expMonth` integer, nullable, required - `expYear` integer, nullable, required - `accountHolderType` string, nullable, required - `accountNumberLast4` integer, nullable, required - `bankName` string, nullable, required - `routingNumber` integer, nullable, required - `description` string, nullable, required - `type` 'CARD' | 'ACH' | 'APPLE_PAY', required - `isDefault` boolean - `isArchived` boolean - `total` integer, required ## Other responses - `422`: Validation Error --- [API](https://skmtc.dev/decodahealth/apis/decoda-api.md) - [All operations](https://skmtc.dev/decodahealth/apis/decoda-api/llms.txt) - [OpenAPI document](https://skmtc.dev/decodahealth/apis/decoda-api/revisions/4ab18c80f9e9?raw)