Manage API Keys

Customers on the Standard and Plus plans have access to the Help Scout API. From your profile page, you can create new API keys, or revoke old keys that are no longer in use.

Generate an API Key

From your profile page: 

  1. Click the Authentication link in the sidebar. 
  2. Click the API Keys tab.
  3. Click the Generate an API Key button. New keys will appear at the top of the table. 

Label API Keys

Labeling your API keys is helpful for knowing which keys are tied to specific integrations. Click the Add a label link to name the API key. 

Revoke API Keys

API keys can be revoked on demand. When a key is revoked, API calls will fail, and any linked integrations will no longer work. Click the red Revoke link to revoke an API key. 

Still stuck? How can we help? How can we help?