Sign in

Platform API

Provision an organization

Create or find a managed organization using your stable externalId.

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

Create or find a managed organization using your stable externalId. Requires an account-scoped credential; an organization-scoped credential is rejected. Returns 201 when created, 200 when found.

AuthenticationBearer server API key
Permissions by credentialServer: orgs:write
IdempotencyRequired for safe retries

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

Request body

FieldTypeDescription
externalIdRequired
string

externalId

nameRequired
string

name

accessMode
string

Legacy invite input is accepted with adminName and adminEmail; this endpoint provisions managed access.

practiceIdentity
object

practiceIdentity

billingProviders
object[]

billingProviders

renderingProviders
object[]

renderingProviders

locations
object[]

locations

adminName
string

adminName

adminEmail
string

adminEmail

Examples

Request
curl 'https://app.mindbill.org/partner/v2/organizations' \
  --request POST \
  --header "Authorization: Bearer $MINDBILL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data @request.json \
  --header 'Idempotency-Key: example-write-0001'

Response

201

Response
Response fields are documented below.
FieldTypeDescription
organizationId
string

organizationId

externalId
string

externalId

name
string

name

status
string

status

accessMode
object

accessMode

created
boolean

created