Tenant API reference

Authorize with a Tenant API key, cr_live_..., and choose your region under Servers. A key works only in the region that issued it.

• Try it out needs an allowed address

  Calls go straight from your browser to the API, so they only work from an address on the key's allowlist, inside any API IP policy your tenant has. Attempts from anywhere else are refused and count against your address.

  IP allowlist and API IP policy

• These are live calls

  Try it out works on your real data in the region you pick, and every call is audited against the key. Your key stays in this page and is forgotten when you leave it. Use a dry run to test a write.

  Dry run

• Sites confine most of a key's reach

  A site-restricted key is confined to its sites for requests, appointments, results and forms. Patients are tenant-wide under every key.

  Scopes and gated fields