Platform API

Get an organization

Read the composed profile.

GEThttps://app.mindbill.org/partner/v2/organizations/{id}

Read the composed profile. The explicit organization id must match the authenticated organization.

AuthenticationServer API key or browser session + Origin
Permissions by credentialServer: orgs:read · Browser: organization:manage
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
idRequired
string

Resource identifier.

Examples

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

Response

200

Response
Response fields are documented below.
FieldTypeDescription
dataRequired
object

data

data.organizationIdRequired
string

organizationId

data.practiceIdentity
object

Practice identity; stored SSNs are masked with taxIdConfigured and taxIdLast4.

data.billingProvidersRequired
object[]

billingProviders

data.renderingProvidersRequired
object[]

renderingProviders

data.locationsRequired
object[]

locations

data.w9Required
object | null

w9

data.onboardingRequired
object

onboarding