Sign in

Lifecycle API

List the bill dashboard

Organization-wide page pagination and dashboard filters.

GEThttps://app.mindbill.org/partner/v2/bill-dashboard

Organization-wide page pagination and dashboard filters. GET /bills retains its cursor contract. Bill-scoped browser sessions cannot list collections.

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.

Query parameters

FieldTypeDescription
patientId
string

Canonical MindBill patient ID; maximum 200 characters.

page
integer

Page number.

pageSize
integer

Rows per page.

q
string

Case-insensitive search across patient, administrator, bill/claim identifiers, external IDs, status, procedure codes, and dates. Every word must match; words may match different fields.

At most 160 characters after trimming
dateField
"service" | "submitted"

Choose the date used by the range filter; defaults to submitted.

from
string

Inclusive start of the selected date range.

Real YYYY-MM-DD date; from must not be after to
to
string

Inclusive end of the selected date range.

Real YYYY-MM-DD date; from must not be after to
status
string

Comma-separated dashboard status keys: incomplete,send,sent,accepted,accepted_no_response,processed,paid,denied,rejected,appealing,lien,ibr,closed.

age
string

Age bucket.

sort
string

Sort column.

dir
string

Sort direction.

claimsAdminId
string

billingProviderId
string

taskKind
string

taskLabel
string

Task label, used with a valid taskKind; maximum 120 characters.

openAr
string

Set to 1 for open accounts receivable.

Examples

Request
curl 'https://app.mindbill.org/partner/v2/bill-dashboard' \
  --request GET \
  --header "Authorization: Bearer $MINDBILL_API_KEY"
Request
curl 'https://app.mindbill.org/partner/v2/bill-dashboard' \
  --request GET \
  --header "Authorization: Bearer $MINDBILL_BROWSER_TOKEN" \
  --header 'Origin: https://your-app.example'

Response

200

Response
{
  "data": {
    "items": [],
    "total": 0,
    "balanceTotal": 0,
    "page": 1,
    "pageSize": 25
  }
}
FieldTypeDescription
data.filtersRequired
object

Authorized patients, renderingProviders, and claimsAdministrators option arrays of { id, name }. Inventories span the authorized lifecycle scope and do not depend on the current page or selected filters.

dataRequired
object

data

data.itemsRequired
object[]

items

data.totalRequired
integer

total

data.balanceTotalRequired
number

balanceTotal

data.pageRequired
integer

page

data.pageSizeRequired
integer

pageSize