> ## Documentation Index > Fetch the complete documentation index at: https://support.affinity.co/llms.txt > Use this file to discover all available pages before exploring further. # Getting Started With The Affinity API + FAQs > Getting Started With The Affinity API + FAQs **Concept** — background and overview. **Last Updated:** November 21, 2025 Welcome to Affinity! We're here to help you get started with the Affinity API so that you can set up webhooks, integrations, and more. **Note**: If you're currently trialing Affinity, you will **not** be able to access the Affinity API until you **purchase** one of the following [subscription tiers](/s/article/Getting-started-with-the-Affinity-API-faqs#h_01HKR2M2PV8C8YA86QQ7J0MJ23): **Scale**, **Advanced**, or **Enterprise**. ## Overview * [Introducing Affinity API V2](/s/article/Getting-started-with-the-Affinity-API-faqs#h_01HKR28A2PYF3QMFZ99C6G20PD) * [Differences between API V1 and API V2](/s/article/Getting-started-with-the-Affinity-API-faqs#h_01HKRBTA0ZF73GK0GY8ZW1WYNB) * [Who has access to Affinity API V1 and API V2?](/s/article/Getting-started-with-the-Affinity-API-faqs#h_01HKR2M2PV8C8YA86QQ7J0MJ23) * [Prerequisites](/s/article/Getting-started-with-the-Affinity-API-faqs#h_01HKR32VNXYS3SQ97E4VJ26KDQ) * [Getting started with the Affinity API](/s/article/Getting-started-with-the-Affinity-API-faqs#01HKR32XDY9PY4BEC6Q6S8M5XM) * [Frequently Asked Questions](/s/article/Getting-started-with-the-Affinity-API-faqs#h_01HE196VJ1CEP1NEPCMCNA35PF) *** ## Introducing Affinity API V2 We're excited to introduce [Affinity API V2](https://developer.affinity.co/docs/v2/), our newly-improved API platform. **Note**: API V1 will not be deprecated at this time - it will still be available alongside API V2. *** ## Differences between API V1 and API V2 | | **API V1** | **API V2** | | --------------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | **Operations supported** | Supports reading and writing data about people, companies, opps, notes, interactions, reminders, and more | Supports reading data about people, companies, and opps (plus support for pulling data by saved view) and writing data to fields on list entries | | **Future support and investment** | Will be supported alongside API V2, but will not get additional investment | Will cover more of API V1's functionality over time, plus more | | **API structure** | More coverage of different operations in Affinity | More intuitive API structure requiring fewer API calls and fewer endpoints for the same data | | **Performance** | Supports basic one-at-a-time operations | Built on a new platform for better performance & reliability | | **OpenAPI spec** | No | Yes | | **Documentation** | [API V1 Documentation](https://api-docs.affinity.co/#introduction) | [API V2 Documentation](https://developer.affinity.co/docs/v2/) | * For those with access to API V2, you will be able to access **both** API V1 and V2 at the same time. * The API calls made to API V1 and V2 will collectively count towards monthly, per-minute, and concurrent API call limits. * API V2 is **not** at feature parity with API V1 at this time. We will continue to add to API V2 so that it covers more of API V1's functionality over time. *** ## Who has access to Affinity API V1 and API V2? | **Subscription Tier** | **Access to API V1** | **Access to API V2** | | --------------------- | -------------------- | -------------------- | | **Essential** | No | No | | **Scale** | Yes | Yes | | **Advanced** | Yes | Yes | | **Enterprise** | Yes | Yes | *** ## Prerequisites **Authentication methods:** * **API V1** uses **Basic Auth or Bearer Auth** * **API V2** uses only **Bearer Auth** For examples of how to authenticate in a variety of languages, see the per-endpoint sample requests in our API docs. **API key creation permissions:** Affinity has role-based permissions for generating API keys. For ease of testing, we recommend starting with an API key belonging to an **Admin** (or Enterprise Admin if your account is on the **Enterprise** tier). * If you're not an Admin and cannot create an API key in Manage Apps, your Enterprise Admin may have restricted the "Generate API Key" permission to certain account roles. See the section titled "What permissions can the Enterprise Admin change? (Enterprise only)" in the article [Account Level Permissions](/s/article/Account-level-permissions). Ask your Enterprise Admin to grant you the "Generate API Key" permission. * If you have a working API key but cannot access certain endpoints described in the [Permissions section](https://developer.affinity.co/docs/v2/#section/Getting-Started/Permissions), your account may have restricted data exports to Admins. Use an Admin/Enterprise Admin API key, or reach out to [support@affinity.co](mailto:support@affinity.co) for help. *** ## Getting started with the Affinity API ### Step 1: Create Your API Key 1. Navigate to **Settings** > **Manage Apps** 2. Click **"+ New App"** 3. **Add a descriptive name** for your integration (required) * Examples: "Salesforce Integration", "Data Warehouse Sync", "Custom Dashboard" 1. **Add a description** (recommended) includ * Purpose of the integration * Owner/team responsible * Systems involved * Contact information 1. Click **"Add App"** 2. Store the key securely (password manager or secrets management system) **Important notes:** * Currently, you can only have 1 active API key per user. Creating a new key will revoke your existing key (with warning). Multiple keys per user coming in future release. * For comprehensive key management instructions, see [How to Create and Manage API Keys](/s/article/How-to-create-and-manage-API-keys) * For admin audit and security workflows, see [How to Audit API Keys in Your Instance](/s/article/How-to-audit-API-keys-in-your-instance) ### Step 2: Review API Capabilities and Rate Limits **Your team will get a certain number of monthly API calls based on your Affinity subscription tier:** * **API V1**: See the [Rate Limits](https://api-docs.affinity.co/#rate-limits) section of our API Documentation * **API V2**: See the [Rate Limits](https://developer.affinity.co/docs/v2/#section/Getting-Started/Rate-Limits) section of our API Documentation **Monitor your API usage:** * Navigate to Settings > Manage Apps to view: * Monthly API limit for your org * Current usage and percentage consumed * Reset date for monthly counter ### Step 3: Explore API Documentation Visit our API Documentation Center: * [**API V1 Documentation**](https://api-docs.affinity.co/#introduction) * [**API V2 Documentation**](https://developer.affinity.co/docs/v2/) **Helpful API articles:** 1. [What data is accessible via the Affinity API?](https://support.affinity.cohttps://developer.affinity.co/) 2. [Types of webhooks available with Affinity's API](https://support.affinity.cohttps://developer.affinity.co/) 3. [How to use Affinity's API to retrieve list data](https://support.affinity.cohttps://developer.affinity.co/) 4. [How to use Affinity's API to create an organization in Affinity](https://support.affinity.cohttps://developer.affinity.co/) 5. [How to use Affinity's API to add an organization to an organization list](https://support.affinity.cohttps://developer.affinity.co/) *** ## Frequently Asked Questions ### API Key Management **Where do I create and manage my API keys?** Navigate to **Settings** > **Manage Apps** to create, view, edit, and revoke API keys. Admins can see all keys across the organization. Standard users with "Generate API Key" permission can manage their own keys. For detailed instructions, see [How to Create and Manage API Keys](/s/article/How-to-create-and-manage-API-keys) and [Manage Apps Reference](/s/article/Manage-apps-reference). **How many API keys can I create?** Currently, each user can have 1 active API key. Creating a new key will revoke your existing key (with warning). Support for multiple API keys per user is coming in a future release. **What happens to API keys when a user is deactivated?** API keys are automatically revoked when a user is deactivated for security. Any integrations using that key will stop working. To restore the integration, have an active user create a new API key and update the integration credentials. See [How to Audit API Keys in Your Instance](/s/article/How-to-audit-API-keys-in-your-instance) for managing deactivated user keys. **Can admins see and manage all API keys in the instance?** Yes. Admins with "Manage All API Keys" permission can view, edit, and revoke all API keys across the organization in Manage Apps, including personal keys and Affinity Help keys from Professional Services. This enables security audits and compliance. ### API Capabilities **What is the per-minute limit for API calls?** * **API V1**: See the [Rate Limits](https://api-docs.affinity.co/#rate-limits) section of our API Documentation. * To see your API usage at the account-level and API-key level, see the [Rate Limit endpoint](https://api-docs.affinity.co/#rate-limit). * **API V2**: See the [Rate Limits](https://developer.affinity.co/docs/v2/#section/Getting-Started/Rate-Limits) section of our API Documentation. * To see your API usage at the account-level and API-key level, see the **Rate Limit Headers** subsection at the end of the [Rate Limits](https://developer.affinity.co/docs/v2/#section/Getting-Started/Rate-Limits) section. **Is it possible to @mention someone when creating notes with the API?** No, this feature is not supported with the API at this time. **Why don't some list entries have a creator\_id associated with them?** The "**creator\_id: null**" is expected behavior when the previous user who created the list entry was removed from your team's Affinity account. **What is accessible vs. not accessible via the API?** For both API V1 and API V2, here are the **Partner Data Restrictions**: **You can pull data from:** * [Affinity Data](/s/article/Affinity-Data) fields * Inclusive [Dealroom.co](http://dealroom.co/) fields (see the section titled "Inclusive [Dealroom.co](http://dealroom.co/) fields (All Affinity customers)" in the article [Dealroom.co](http://dealroom.co/)[ data in Affinity](/s/article/Dealroom-co-data-in-Affinity)) **You cannot pull data from:** * Crunchbase, including Crunchbase UUID * Pitchbook * The exclusive [Dealroom.co](http://dealroom.co/) fields (see the section titled "Exclusive [Dealroom.co](http://dealroom.co/) fields (Only for specific tiers with a [Dealroom.co](http://dealroom.co/) subscription) in the article [Dealroom.co](http://dealroom.co/)[ data in Affinity](/s/article/Dealroom-co-data-in-Affinity)) For more details, check out [What data is accessible via the Affinity API?](https://support.affinity.cohttps://developer.affinity.co/)