Skip to main content
GET
/
api
/
v1
/
admin
/
organizations
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "branding": {},
  "child_organizations": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "created_at": "<string>",
  "invoicing_profile": {
    "id": "<string>",
    "billing_model": "commission",
    "commission_rate": "<string>",
    "enabled": true,
    "payment_terms": "net15",
    "per_user_rate": 123
  },
  "linked_entity_id": "<string>",
  "linked_entity_name": "<string>",
  "logo_url": "<string>",
  "members_count": 123,
  "name": "<string>",
  "npi": "<string>",
  "org_category": "<string>",
  "org_type": "<string>",
  "parent_organization": {
    "id": "<string>",
    "name": "<string>"
  },
  "providers_count": 123,
  "settings": {},
  "slug": "<string>",
  "status": "active",
  "tax_id": "<string>",
  "updated_at": "<string>"
}

Path Parameters

id
string
required

Response

200 - application/json

OK

id
string
required
branding
object
required
child_organizations
object[]
required
created_at
string
required
invoicing_profile
object
required
linked_entity_id
string | null
required
linked_entity_name
string | null
required
logo_url
string | null
required
members_count
integer
required
name
string
required
npi
string | null
required
org_category
string
required
org_type
string
required
parent_organization
object
required
providers_count
integer
required
settings
object
required
slug
string
required
status
enum<string>
required
Available options:
active,
suspended,
deactivated,
onboarding,
pending_review
tax_id
string | null
required
updated_at
string
required