Set up credentials
You generate an Affinity API key from the Manage Apps page in your Affinity settings. You need the Generate API Key permission, and API access requires a Scale, Advanced, or Enterprise plan.Create a new API key
Click + New App (or Create New API Key). Enter a descriptive
Name and an optional Description for the integration.
Each user can have only one active API key at a time. Creating a new key
revokes the existing one. Keys are also automatically revoked when a user is
deactivated.
Connect to Adapt
Add your credentials
Enter the values you gathered above, then click Add connection:
You can rename the connection and choose whether it is shared with your
organization or kept personal to you.
| Secret Name | Value |
|---|---|
AFFINITY_API_KEY | Your Affinity API key |
Security
- Credentials are encrypted at rest with AES-256
- The API key inherits the permissions and data access of the user who created it, so use an account scoped to only what you need
- Optionally define an IP allowlist on the key to restrict where it can be used
- Never share the API key publicly or commit it to source control