Skip to main content
A sub-entity is a workspace whose parent is your workspace. Use one per store, clinic location, franchisee or agency client. Each child keeps its own phone numbers, agents, contacts, calls and recordings. The parent creates and lists them, and its caller registration covers them. Agencies doing this from the app should read Add a dealer workspace.

What a child shares and owns

When RevDesk looks up a child’s caller registration, it uses the child’s own registration first, then the parent’s. Register once on the parent and every child’s numbers are covered.

Keys and scopes

The sub-entity endpoints need an API key created in the parent workspace, with these scopes:
  • sub_entities:read to list and read children.
  • sub_entities:write to create and rename them.
  • compliance:write as well, to change hipaa_enabled. It’s never granted by default.
A key created inside a child workspace (switch to it, then Settings › API Keys) sees only that child’s numbers, calls, contacts and messages, and what it creates belongs to that child. Give these to a location’s own team or a vendor who manages one location. A child key can read the parent’s caller registration through /v1/caller-trust/* but can’t change it.

Endpoints

Create

slug is optional. Without it, RevDesk makes one from the name. Slugs are lowercase letters, numbers and hyphens, up to 64 characters, and unique across RevDesk; a taken slug returns 409. The person who owns the key becomes the child’s owner.

List

Newest first, up to 100 per page. Pass meta.cursor back as cursor for the next page. member_count and phone_number_count show which children are live.

Get one

A child that isn’t under your workspace returns 403.

Update

You can change name and hipaa_enabled.

HIPAA

A child of a HIPAA-enabled parent starts HIPAA-enabled. While the parent has HIPAA on, setting hipaa_enabled: false on a child returns 403. Turning HIPAA on for a child also sets its call-recording retention to 30 days, which you can change per number afterward. The parent’s BAA covers its children. See HIPAA and BAA.

Own caller registration

If a child is a separate legal business with its own caller name, register it with a key scoped to that child: POST /v1/caller-trust/enterprise, then POST /v1/caller-trust/enterprise/sign-and-submit. See Caller trust.