Restricted API keys

Restricted API keys let you scope an API key user’s access to specific resources — workflows, pages, forms, files, data sets, folders, or saved views. Instead of giving an API key full admin access, you can limit it to exactly what it needs.

Availability: Restricted API keys are available on Enterprise plans.

How restricted API keys work

Every API key has an associated API key user in your organization. By default, that user is created as an Admin. With restricted API keys, you can change the user’s role and grant access to only the specific resources it needs.

API key users have a few important properties:

• They’re never added to the All Organization group.
• They only see resources you explicitly share with them.
• Their role and permissions can be updated at any time.

Manage API key user access

To view and manage your API key users, go to Users & Guests → API Key Users.

From there you can:

• See all API key users in your organization
• Change a API key user’s role

Create a restricted API key

1. Go to API Keys.
2. Click + New API Key.
3. A dialog displays the full API key. Copy and store it in a secure location immediately. Check the confirmation box to acknowledge you’ve saved the key, then click Done.
4. Give the key a name.
5. Go to Users & Guests and filter by API Key Users.
6. Set the user’s role. Choose Builder role for the most flexibility.
7. Go to the specific workflows, pages, forms, files, data sets, folders, or saved views and assign the appropriate permissions to the API key user with the key name you created.

Note: After you close the dialog, the key is permanently masked and only the last 4 characters are visible. If you lose the key, use the Regenerate button next to it in the API keys list to create a new one. Regenerating replaces the old secret, so update any integrations that use it.

Frequently asked questions

Can I update an existing API key’s permissions?

Yes. Go to Users & Guests → API Key Users, find the key, and edit its role, then go to each workflow, form, file, folder, etc. and assign the API key user to it. Changes take effect immediately.

What happens if I give an API key Admin access?

It behaves the same as a full admin API key. No resources are restricted unless you explicitly limit them.

Are API key users counted toward my seat limit?

API key users are separate from your regular user seats. Check your plan details for specifics.

• Learn the 5 stages of process building in our Getting started guide
• Watch helpful videos and webinars on our YouTube channel
• Learn about Process AI
• Collect info with Forms
• Organize data with Data Sets
• Document information and policies with Pages
• Get inspired by our Blog