Platform API

List organizations

List the customer organizations available to the current key and environment.

GEThttps://app.mindbill.org/partner/v2/organizations

Reconcile the organization IDs linked to an account-scoped key. An organization-scoped key returns only its fixed organization.

AuthenticationBearer server API key

Permissions by credentialServer: orgs:read

IdempotencyNot required

This endpoint requires a server API key and is unavailable to browser sessions. See the component API inventory for exact paths and SDK methods.

Examples

curl 'https://app.mindbill.org/partner/v2/organizations' \
+  --request GET \
+  --header "Authorization: Bearer $MINDBILL_API_KEY"

Response

200

{
  "data": [
    {
      "organizationId": "org_01example",
      "externalId": "practice_42",
      "name": "Example Medical Group",
      "status": "active"
    }
  ]
}

FieldTypeDescription

dataRequired

object[]

Organizations linked to the key in its current sandbox or live environment.

data[].organizationIdRequired

string

MindBill organization ID to send in X-MindBill-Org-Id.

data[].externalIdRequired

string | null

Stable customer ID supplied when the organization was provisioned.

data[].nameRequired

string

Organization display name.

data[].statusRequired

string

Current onboarding or activation status.