How to obtain your Affinity API key

Access to Affinity's API is available for our customers on the Professional*, Premium, and Enterprise tiers. To learn more about Affinity's API, please see our API Documentation.

* - Professional tier customers who have signed up before July 5, 2023 will have access to 40,000 API calls/month, while those who have signed up on/after July 5, 2023 will not have API access.

How to obtain your Affinity API key

1. Click Settings on the left-side of your screen.
   
   
   
2. Click on the API tab, then click on Generate an API key.
   
   Note: For those on the Enterprise tier, the Enterprise Admin may have disabled the ability for Admin and/or Standard users to generate an API key (see What permissions can the Enterprise Admin change?). If you're an Admin or Standard user and cannot generate an API key, please reach out to your Enterprise Admin.

Important Callouts

• If you lose your key, a new API key would need to be generated as the old API key will render invalid.
• API keys generated by users that are deactivated will have their API key render invalid.
• For Enterprise Admins on the Enterprise tier:
  • If you remove the permission for Admin and/or Standard users to generate an API key, the following will occur:
    • They can no longer generate an API key (the API tab in Settings will be hidden).
    • All existing API keys attached to each user will be disabled.
  • If you decide to reenable the permission for Admin and/or Standard users to generate an API key, the following will occur:
    • Their previous API keys will not be reenabled and they will need to generate a new API key by following the steps above.