Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.revdesk.com/llms.txt

Use this file to discover all available pages before exploring further.

​
When you need sub-entities

Your org has multiple semi-independent business units and you want each to have its own phone numbers, agents, and settings — but you manage them from one RevDesk seat. Common cases:
  • Healthcare network — one parent entity, many clinic locations, each with its own outbound numbers.
  • Franchise — one brand, many franchisees.
  • Agency — one agency, many end-client workspaces.
Every sub-entity is a Team with parent_organization_id pointing to your umbrella org. Members can belong to the umbrella, a specific sub-entity, or both. Phone numbers, calls, reputation tracking, and brand registration are all sub-entity-scoped.

​
What sub-entities share vs. own

ResourceShared with umbrellaOwned by sub-entity
Caller Trust enterprise (LOA, EIN, DIR)✓ — one umbrella LOA covers every sub-entity by defaultOptional — a sub-entity can register its own enterprise if it has a separate legal identity
Phone numbers✗✓
Agents + voice config✗✓
Call history + recordings✗✓
Billingdepends on plan — pooled on Scale, independent below—
HIPAA postureinherited on creation, editable per sub-entity—
The reputation-enrollment service walks the hierarchy automatically: when a phone on a sub-entity is provisioned, it looks for a team-level enterprise first, then the parent org’s enterprise, then falls back to the Cell Labs umbrella. So you register once at the umbrella, and every sub-entity’s numbers are covered.

​
Managing sub-entities via API

# Create
curl -X POST https://api.revdesk.com/v1/sub-entities \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Northside Clinic", "slug": "northside-clinic"}'

# List
curl https://api.revdesk.com/v1/sub-entities \
  -H "Authorization: Bearer $KEY"

# Get one
curl https://api.revdesk.com/v1/sub-entities/42 \
  -H "Authorization: Bearer $KEY"

# Toggle HIPAA
curl -X PATCH https://api.revdesk.com/v1/sub-entities/42 \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"hipaa_enabled": true}'
Required scopes: sub_entities:read, sub_entities:write. The API key must be org-scoped OR held by a user who’s an ADMIN / OWNER of exactly one umbrella organization. If you’re an admin of multiple umbrellas, create an org-scoped API key for the specific one you want to manage.

​
Provisioning phone numbers under a sub-entity

The team_id parameter on POST /v1/phone-numbers (coming in the next release) targets a specific sub-entity. Until then, use the dashboard’s sub-entity switcher to scope provisioning UI — the number gets created with teamId = sub-entity-id and is visible only within that sub-entity.

​
HIPAA inheritance

Creating a sub-entity under a HIPAA-enabled parent auto-inherits the flag. A sub-entity can opt out by setting hipaa_enabled: false, but that’s unusual — you’d typically leave everything on if the parent has executed a BAA. See BAA & HIPAA for what this flag actually gates.