Lifecycle API

Get the complete bill workspace

Read the immutable submitted bill snapshot, human-readable activity history, current lifecycle, EORs, payments, remittance, and payer contacts.

GEThttps://app.mindbill.org/partner/v2/bills/{billId}/lifecycle

Read the immutable submitted bill snapshot, human-readable activity history, current lifecycle, EORs, payments, remittance, and payer contacts. Partners do not need to maintain a separate bill-history store.

AuthenticationServer API key or browser session + Origin

Permissions by credentialServer: bills:read · Browser: bills:read

IdempotencyNot required

Use this URL with a server API key or a browser session and its exact allowed Origin. Both credentials use the same request and response contract. See the component API inventory for exact paths and SDK methods.

Path parameters

FieldTypeDescription

billIdRequired

string

MindBill bill ID.

Examples

curl 'https://app.mindbill.org/partner/v2/bills/{billId}/lifecycle' \
  --request GET \
  --header "Authorization: Bearer $MINDBILL_API_KEY"

curl 'https://app.mindbill.org/partner/v2/bills/{billId}/lifecycle' \
  --request GET \
  --header "Authorization: Bearer $MINDBILL_BROWSER_TOKEN" \
  --header 'Origin: https://your-app.example'

Response

200

Response fields are documented below.

FieldTypeDescription

dataRequired

object

data

data.environmentRequired

string

Credential environment used to load this lifecycle.

data.billRequired

object

The same immutable submitted bill snapshot returned by the bill-review surface.

data.patientRequired

object

patient

data.injuryRequired

object

injury

data.options

object

Display metadata retained for compatible embedded components.

data.lifecycleRequired

object

lifecycle

data.eorsRequired

object[]

eors

data.attemptsRequired

object[]

Immutable delivery attempts in the logical bill chain, oldest first. Every successful transmission, including Second Review, is a separate row even when it reuses the same bill record.

data.historyRequired

object[]

One chronological timeline spanning every delivery attempt. Each row identifies its correction-chain member bill record via attemptId.

data.activityRequired

object[]

activity

data.paymentsRequired

object[]

payments

data.remittanceRequired

object

remittance

data.deliveryRequired

object

delivery