API keys
Retyc exposes a public API that lets you integrate your tools (scripts, monitoring, HR systems, DMS...) with your organization: browsing members, transfers and datarooms, automations. Access is granted through organization-level API keys.
Restricted to Owners and Admins.
Create a key
- Go to Dashboard > Organization > API keys
- Give the key a name (e.g. "Monitoring")
- Pick its validity duration: the key expires automatically
- Tick the scopes to grant
- Click Create the key
The key secret is shown only once at creation time: copy it immediately into your secrets manager.
Scopes
Each key is limited to the permissions you select:
| Scope | Access |
|---|---|
organization:read | Read the organization information and members |
organization:write | Modify the organization |
transfer:read | Read transfers |
transfer:write | Manage transfers |
dataroom:read | Read datarooms |
dataroom:write | Manage datarooms |
Only grant the scopes each usage requires: a monitoring key only needs read scopes.
IP restriction
At the bottom of the page, you can restrict the use of API keys to a list of allowed IP addresses. Enable Restrict API keys to allowed IPs, then paste your list of addresses. A key used from an unlisted IP is rejected.
Revoke a key
The Existing keys section lists the active keys with their expiration. Delete a key to revoke its access immediately.
API documentation
The full reference of the public API (endpoints, schemas, authentication) is available through the Documentation button at the top of the API keys page.
The public API cannot decrypt your files: end-to-end encryption applies to integrations too. API keys give access to metadata and management operations, never to cleartext content.