--- title: Generating an API Key/Access Token description: Learn how to generate an API key/access token, define the API key settings and view the API documentation. Availability based on subscription. Access based on role permissions. --- [Skip to content](https://knowledge.spark.re/generating-an-api-key-access-token#main-content) [More support](https://knowledge.spark.re/kb-tickets/new?hsLang=en) ![spark\_re\_logo\_wht](https://knowledge.spark.re/hs-fs/hubfs/spark_re_logo_wht.png?width=150&height=48&name=spark_re_logo_wht.png) Open main navigation Close main navigation - [More support](https://knowledge.spark.re/kb-tickets/new) Hello. How can we help you? - There are no suggestions because the search field is empty. 1. [Knowledge Base](https://knowledge.spark.re/?hsLang=en) 2. [Project Settings](https://knowledge.spark.re/project-settings?hsLang=en) 3. [API](https://knowledge.spark.re/project-settings?hsLang=en#api) # Generating an API Key/Access Token If your subscription includes access to the API and your role’s permissions permit, go to *Settings → API* to manage the project’s API keys. To generate a new key, click **+ Generate Key**. Give the access token a description so you and your team will be able to differentiate it from any other API keys. Next, use the toggles to specify which resources the key should be permitted to access, and whether that access should be "read" or "write" (or both). For best security practice, you should only give access to the resources required for the specific action(s) you will be performing with your key.    Note: You can create an unlimited number of keys, so we encourage you to create a key for each individual application/integration you use. That way, if one key should be compromised, you can easily deactivate it without impact to your other integrations.   If the API key/access token will be used to post contacts into the project database, use the remainder of the API settings to specify how incoming contacts should be handled. For example, you can apply a follow-up schedule, automatically assign incoming contacts to team members, send an auto-reply email and send a notification email to specified team members. To edit any of these settings, click the **pencil icon** next to the access token. To view the API Documentation, click the **Documentation** button. - [Contacts](https://knowledge.spark.re/contacts?hsLang=en#main-content) - [Contact Management](https://knowledge.spark.re/contacts?hsLang=en#contact-management) - [Interactions](https://knowledge.spark.re/contacts?hsLang=en#interactions) - [Groups](https://knowledge.spark.re/contacts?hsLang=en#groups) - [Inventory](https://knowledge.spark.re/inventory?hsLang=en) - [Contracts](https://knowledge.spark.re/contracts?hsLang=en#main-content) - [Disclosures & Amendments](https://knowledge.spark.re/contracts?hsLang=en#disclosures-amendments) - [Contract Management](https://knowledge.spark.re/contracts?hsLang=en#contract-management) - [Deposits](https://knowledge.spark.re/contracts?hsLang=en#deposits) - [Files](https://knowledge.spark.re/contracts?hsLang=en#files) - [Commissions](https://knowledge.spark.re/contracts?hsLang=en#commissions) - [Conveyancing](https://knowledge.spark.re/conveyancing?hsLang=en#main-content) - [Deposits](https://knowledge.spark.re/conveyancing?hsLang=en#deposits) - [Commissions](https://knowledge.spark.re/conveyancing?hsLang=en#commissions) - [Emails](https://knowledge.spark.re/emails?hsLang=en#main-content) - [Email Templates](https://knowledge.spark.re/emails?hsLang=en#email-templates) - [Email Campaigns](https://knowledge.spark.re/emails?hsLang=en#email-campaigns) - [Contract Emails](https://knowledge.spark.re/emails?hsLang=en#contract-emails) - [Email Sync](https://knowledge.spark.re/emails?hsLang=en#email-sync) - [RSVP](https://knowledge.spark.re/rsvp?hsLang=en) - [Calendar & Events](https://knowledge.spark.re/calendar-events?hsLang=en) - [Parking & Storage](https://knowledge.spark.re/parking-storage?hsLang=en#main-content) - [Parking](https://knowledge.spark.re/parking-storage?hsLang=en#parking) - [Storage](https://knowledge.spark.re/parking-storage?hsLang=en#storage) - [Files](https://knowledge.spark.re/files?hsLang=en) - [Forms](https://knowledge.spark.re/forms?hsLang=en#main-content) - [Registration Forms](https://knowledge.spark.re/forms?hsLang=en#registration-forms) - [Project Questions (Q&A)](https://knowledge.spark.re/forms?hsLang=en#project-questions-qa) - [Request Forms](https://knowledge.spark.re/forms?hsLang=en#request-forms) - [Project Settings](https://knowledge.spark.re/project-settings?hsLang=en#main-content) - [Team](https://knowledge.spark.re/project-settings?hsLang=en#team) - [API](https://knowledge.spark.re/project-settings?hsLang=en#api) - [Contacts](https://knowledge.spark.re/project-settings?hsLang=en#contacts) - [Inventory](https://knowledge.spark.re/project-settings?hsLang=en#inventory) - [Contracts](https://knowledge.spark.re/project-settings?hsLang=en#contracts) - [Conveyancing](https://knowledge.spark.re/project-settings?hsLang=en#conveyancing) - [Communications](https://knowledge.spark.re/project-settings?hsLang=en#communications) - [Analytics](https://knowledge.spark.re/analytics?hsLang=en) - [Integrations](https://knowledge.spark.re/integrations?hsLang=en#main-content) - [Calls & Messages](https://knowledge.spark.re/integrations?hsLang=en#calls-messages) - [Email](https://knowledge.spark.re/integrations?hsLang=en#email) - [Juniper by Spark](https://knowledge.spark.re/juniper-by-spark?hsLang=en#main-content) - [Catalog](https://knowledge.spark.re/juniper-by-spark?hsLang=en#catalog) - [Home Inspection App](https://knowledge.spark.re/juniper-by-spark?hsLang=en#home-inspection-app) - [Integrations](https://knowledge.spark.re/juniper-by-spark?hsLang=en#integrations) - [Users](https://knowledge.spark.re/juniper-by-spark?hsLang=en#users) - [Service Requests](https://knowledge.spark.re/juniper-by-spark?hsLang=en#service-requests) - [Company Settings](https://knowledge.spark.re/company-settings?hsLang=en#main-content) - [Contacts](https://knowledge.spark.re/company-settings?hsLang=en#contacts) - [Brokerages](https://knowledge.spark.re/company-settings?hsLang=en#brokerages) - [Communications](https://knowledge.spark.re/company-settings?hsLang=en#communications) - [Webinars](https://knowledge.spark.re/webinars?hsLang=en#main-content) - [Spark Lunch & Learns](https://knowledge.spark.re/webinars?hsLang=en#spark-lunch-learns) - [Product Webinars](https://knowledge.spark.re/webinars?hsLang=en#product-webinars) - [General](https://knowledge.spark.re/general?hsLang=en#main-content) - [Account Settings](https://knowledge.spark.re/general?hsLang=en#account-settings) - [Beta](https://knowledge.spark.re/beta?hsLang=en#main-content) - [Contact Page](https://knowledge.spark.re/beta?hsLang=en#contact-page) [![\_Mark + Logotype](https://knowledge.spark.re/hs-fs/hubfs/_Mark%20+%20Logotype.png?width=150&height=48&name=_Mark%20+%20Logotype.png "_Mark + Logotype")](https://www.spark.re) [Still need help? Contact us.](https://knowledge.spark.re/kb-tickets/new?hsLang=en) Copyright © 2025, Spark