Skip to main contentOverall Requirements
You must have the “Generate an API key” permission to be able to work with the Affinity API. Most
users in Affinity have this by default — Contact your Affinity admin if you are not able to generate
an API key, and see
this article
for more information on role-based permissions in Affinity.
Resource-Level Permissions
The Affinity API respects sharing permissions that are set in-product. For example, if a given user
does not have access to a list, note, or interaction in-product, they will not be able to see or
modify it via API.
Endpoint-Level Permissions
Many API endpoints require endpoint-specific permissions in-product. These permissions, along with
the “Generate an API key” permission, are managed by your Affinity admin in the Settings page. In
the description of each endpoint you will see the required permissions needed. 
