Skip to main content
An API key authenticates every call your backend makes to StackOne. Keys are scoped to a single project — a key can only reach the connector profiles and linked accounts in the project it was created in.

​
Generate an API key

1

Open the API Keys section

Log in to the StackOne dashboard and go to Project Settings → API Keys in the left navigation.
API Keys management page
2

Create a key

Click Create API key and enter a name (e.g. my-agent-key or production-hris-sync). This label can’t be changed later.
Create API key dialog with scopes
3

Configure scopes

New keys come with a default set of scopes. Expand the Scopes section to enable or restrict access for your use case. The scopes reference below lists what each scope allows.
4

Copy and store the key

After clicking Generate, the key is shown once. Copy it immediately and store it securely.
Store the key in a password manager or secrets vault. Never commit API keys to source control.

​
Scopes

An API key’s scopes control what it can access. Set them when creating the key; new keys start with the defaults below.
For AI agents, you typically need: Platform API Read (list connected accounts), Actions Execute (RPC and MCP), Connectors Read (download connectors), and Credentials Read (direct provider access).

​
Key management

Your key appears in the API Keys table, where you can enable, disable, view scopes for, and delete keys at any time. Usage is tracked — the Last used column helps you spot stale keys to revoke. Review the list regularly.

​
Next steps

Connect Session

Use your key to create a session token and open the account-linking flow for a user.

Overview

Return to the end-to-end embedding journey.