Data room API in Peony: public REST API with scoped API keys

Peony's data room API, a REST API with scoped API keys, has been live since August 12, 2026. It is a Deal Team feature enabled on request and is included on Enterprise. It creates data room links and uploads files from your own systems, and later releases added link, access-rule and permission endpoints, file deletion and sending agreements from templates.

What does it do?

The public API lets your own systems do in Peony what an admin would otherwise do by hand. It is a JSON REST API at /api/v1, with an interactive reference at /api/v1/docs and a machine-readable OpenAPI 3.1 document at /api/v1/openapi.json.

Today's operations:

Links: list a folder's links, retrieve a link, create a link for a folder, replace a link's settings and delete a link.
Access rules and permissions: read and change a link's access-rule lists and its granular permission entries.
Files: start and complete an upload into a folder, and delete a file.
Agreements: send an agreement from a template.

Who is it for?

Teams that want data room access to follow their own systems. Examples include creating a personalised link when a buyer is added in a deal-management tool, syncing an email allow list with a membership platform, or uploading files from an internal pipeline.

How does it work?

Once API access is enabled for your workspace, create an API key in Peony and choose its scopes: links:read, links:write, files:write, files:delete and agreements:send.
Send requests with the key as a bearer token. Each operation needs one exact scope; links:write does not imply links:read.
Write operations take an Idempotency-Key header so a retried request is not applied twice. Replacing a link's settings or permissions also takes If-Match so you don't overwrite a change made in the meantime.

Keys are valid for one year and can't be renewed in place. Several keys can be active at once, so you can rotate without downtime.

The API grew in steps:

August 12, 2026: launch, with scoped keys, folder link creation and file uploads.
August 28, 2026: link reads, access rules, granular permissions, link replacement and deletion.
September 29, 2026: file deletion.
October 28, 2026: sending agreements from templates.

Which plans include it?

API access is a Deal Team feature ($64 per admin per month billed annually, $89 billed monthly, minimum 4 admins), enabled on request: email sean@peony.ink to turn it on for your workspace. It is included on Enterprise. It is not included on Free, Business or Data Room. See pricing.

How does it compare?

Many virtual data rooms offer API access only on enterprise contracts. Peony's API comes with a published OpenAPI document, and each key is limited to the scopes you choose.

Where can I learn more?

Common questions

Does Peony have a data room API?

Yes. Peony's public REST API v1 has been live since August 12, 2026. It is a Deal Team feature, enabled on request, and is included on Enterprise. It has an OpenAPI 3.1 reference at /api/v1/openapi.json.

Does a Peony API key have full access?

No. Each key carries only the scopes you assign, such as links:read or files:write, and a request without the required scope is refused. Keys are valid for one year.