---
title: API Keys
description: API Keys are used to authenticate and validate users when calling API's. This is a modern and  secure method for organisations to manage who uses the API's.
---

[Skip to content](https://guide.contentcatalyst.com/api-keys#main-content)

![CC logo blue-1 (1)](https://guide.contentcatalyst.com/hs-fs/hubfs/CC%20logo%20blue-1%20(1).png?width=200&height=89&name=CC%20logo%20blue-1%20(1).png)

- [Guide & Help](https://guide.contentcatalyst.com/)
- [Main Website](https://contentcatalyst.com/)
- [Go to Customer Portal](https://guide.contentcatalyst.com/tickets-view)

Open main navigation

Close main navigation

- [Guide & Help](https://guide.contentcatalyst.com/)
- [Main Website](https://contentcatalyst.com/)
- [Go to Customer Portal](https://guide.contentcatalyst.com/tickets-view)
- [Main Website](https://contentcatalyst.com/)

[Main Website](https://contentcatalyst.com/)

 Learn all about the platform

- There are no suggestions because the search field is empty.

1. [Guide & Help](https://guide.contentcatalyst.com/?hsLang=en)
2. [Operations & Administration support](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en)
3. [API](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#api)

# API Keys

## API Keys are used as the authentication method that replaces basic authentication for API access.

API Keys makes API access easier to manage for administrators. Site administrators can fully control which users are able to use APIs via preferences. Your integration code is simpler, with fewer moving parts to maintain. API keys do not require token exchange, encoding, or caching logic.

### Who can create API Keys?

API Key creation is controlled by your administrators, so your organisation decides exactly who is able to generate keys.

This can be configured Globally, by Accounts, or by User via the **Accounts \> Global Preferences \> Advanced** \> **Can use API Keys**

🔔**Note:** For more information on setting Global Preferences see [Global/Account/User Preferences.](https://guide.contentcatalyst.com/hc/en-gb/articles/212093086-global-account-user-preferences?hsLang=en)

Once permissions have been assigned, users can then create the API key or keys from their user profile page.

### Creating and managing your keys

Users with permission can create and manage their keys from **API key management page**, via the edit profile page. 

![](https://guide.contentcatalyst.com/hs-fs/hubfs/image-png-Jul-08-2026-09-26-46-8781-AM.png?width=233&height=270&name=image-png-Jul-08-2026-09-26-46-8781-AM.png)

Select **Manage API Keys**

![](https://guide.contentcatalyst.com/hs-fs/hubfs/image-png-Jul-08-2026-09-29-09-7127-AM.png?width=365&height=440&name=image-png-Jul-08-2026-09-29-09-7127-AM.png)

Follow steps below to create the keys.

1. **Create a key** — each user can hold up to 6 API keys at a time. This makes it easy to use separate keys for different integrations or environments.
   
   ![](https://guide.contentcatalyst.com/hs-fs/hubfs/image-png-Jul-07-2026-04-24-12-4855-PM.png?width=402&height=224&name=image-png-Jul-07-2026-04-24-12-4855-PM.png)
2. **Set a lifetime** — Use the Key lifetime dropdown menu to specify how long it remains valid, up to a maximum of 24 months.
3. **Copy The new API key** — For security, the key value itself is only visible at the moment of creation. Make sure you copy and store it securely at that point. Afterwards, you cannot view the key again. You can view data about your existing keys — such as their status and lifetime — but never the key value itself. If a key is lost, simply delete it and create a new one.
   
   ![](https://guide.contentcatalyst.com/hs-fs/hubfs/image-png-Jul-07-2026-04-22-30-8527-PM.png?width=490&height=227&name=image-png-Jul-07-2026-04-22-30-8527-PM.png)
4. **Enable or disable a key** — keys can be disabled off without being deleted, which is useful if you need to pause an integration or investigate unexpected activity.
   
   ![](https://guide.contentcatalyst.com/hs-fs/hubfs/image-png-Jul-07-2026-04-28-46-5942-PM.png?width=670&height=159&name=image-png-Jul-07-2026-04-28-46-5942-PM.png)  
   ![](https://guide.contentcatalyst.com/hs-fs/hubfs/image-png-Jul-07-2026-04-36-33-8535-PM.png?width=670&height=133&name=image-png-Jul-07-2026-04-36-33-8535-PM.png)
5. **Delete a key** — permanently removes the key so it can no longer be used.

### **Reporting API Keys**

To view users who currently have API keys assigned, administrators can run the **List API Key Users** report under  **Admin \> General**. This report displays all users allowed to use API Keys.

The report can be downloaded as a .xlsx file.

### Managing keys via the API

Key management is also available through the API itself, so everything you can do on the key management page — creating, listing, enabling, disabling, and deleting keys — can be automated as part of your own workflows. As with the management page, listing keys returns details about each key but never the key value.

### Getting started using API keys

Once a Key has been created simply follow the steps below to authenticate API calls:

1. Add the `X-Api-Key $mykey` as a header  to your API requests
2. Remove your old Basic authentication logic if this is still being used.

API Keys allow for easier API access with less code and better control overall for your users.

 

 

- [Setting Up Your Content Catalyst Subscriber Portal](https://guide.contentcatalyst.com/setting-up-your-content-catalyst-subscriber-portal?hsLang=en#main-content)

    - [Onboarding](https://guide.contentcatalyst.com/setting-up-your-content-catalyst-subscriber-portal?hsLang=en#onboarding)
    - [Site Options](https://guide.contentcatalyst.com/setting-up-your-content-catalyst-subscriber-portal?hsLang=en#site-options)
    - [Showcase Page](https://guide.contentcatalyst.com/setting-up-your-content-catalyst-subscriber-portal?hsLang=en#showcase-page)
    - [Export Template Customisation & Branding](https://guide.contentcatalyst.com/setting-up-your-content-catalyst-subscriber-portal?hsLang=en#export-template-customisation-branding)
    - [Site Design & Branding](https://guide.contentcatalyst.com/setting-up-your-content-catalyst-subscriber-portal?hsLang=en#site-design-branding)
- [Site Authentication & User Registration](https://guide.contentcatalyst.com/site-authentication-user-registration?hsLang=en#main-content)

    - [Site Access](https://guide.contentcatalyst.com/site-authentication-user-registration?hsLang=en#site-access)
    - [User Registration](https://guide.contentcatalyst.com/site-authentication-user-registration?hsLang=en#user-registration)
    - [SSO](https://guide.contentcatalyst.com/site-authentication-user-registration?hsLang=en#sso)
- [Account & User Management](https://guide.contentcatalyst.com/account-user-management?hsLang=en#main-content)

    - [Account Creation & Management](https://guide.contentcatalyst.com/account-user-management?hsLang=en#account-creation-management)
    - [User Creation & Management](https://guide.contentcatalyst.com/account-user-management?hsLang=en#user-creation-management)
    - [Security](https://guide.contentcatalyst.com/account-user-management?hsLang=en#security)
    - [Account Manager Creation & Management](https://guide.contentcatalyst.com/account-user-management?hsLang=en#account-manager-creation-management)
    - [Guest Access](https://guide.contentcatalyst.com/account-user-management?hsLang=en#guest-access)
- [Licensing & Access Management](https://guide.contentcatalyst.com/licensing-access-management?hsLang=en#main-content)

    - [Creating & Managing Licenses](https://guide.contentcatalyst.com/licensing-access-management?hsLang=en#creating-managing-licenses)
    - [Prevent Full Downloads](https://guide.contentcatalyst.com/licensing-access-management?hsLang=en#prevent-full-downloads)
    - [Remote Access](https://guide.contentcatalyst.com/licensing-access-management?hsLang=en#remote-access)
    - [Restrict Export Formats](https://guide.contentcatalyst.com/licensing-access-management?hsLang=en#restrict-export-formats)
- [Organise, Categorise, and Link Content](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#main-content)

    - [Creating & Managing Category Trees](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#creating-managing-category-trees)
    - [Configuring Category Landing Pages](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#configuring-category-landing-pages)
    - [Category & Report Covers](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#category-report-covers)
    - [Chapters & Sections](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#chapters-sections)
    - [Analysts](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#analysts)
    - [Tags](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#tags)
    - [Report Series & Linked Reports](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#report-series-linked-reports)
    - [Promote Categories](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#promote-categories)
- [Create & Deliver Content and Data](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#main-content)

    - [Report Metadata](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#report-metadata)
    - [Importing Content](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#importing-content)
    - [Instant Insights/Briefings](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#instant-insights-briefings)
    - [Interactive Docs](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#interactive-docs)
    - [DocuViewer](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#docuviewer)
    - [PDF/SlideViewer](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#pdf-slideviewer)
    - [Power BI](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#power-bi)
    - [Video Content](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#video-content)
    - [External Reports](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#external-reports)
    - [Publishing Workflow](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#publishing-workflow)
    - [DataViewer](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#dataviewer)
    - [RSS Feeds](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#rss-feeds)
- [Operations & Administration support](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#main-content)

    - [Domain Configuration](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#domain-configuration)
    - [Email Deliverability](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#email-deliverability)
    - [Search Configuration](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#search-configuration)
    - [Chargeback Codes](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#chargeback-codes)
    - [Policies & Notices](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#policies-notices)
    - [API](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#api)
- [Site Extensions & Integrations](https://guide.contentcatalyst.com/site-extensions-integrations?hsLang=en#main-content)

    - [CRM Integrations](https://guide.contentcatalyst.com/site-extensions-integrations?hsLang=en#crm-integrations)
    - [Integrations](https://guide.contentcatalyst.com/site-extensions-integrations?hsLang=en#integrations)
- [Tracking & Analytics of Subscriber Use](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#main-content)

    - [General](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#general)
    - [Report Access](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#report-access)
    - [Popular Searches](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#popular-searches)
    - [Tracking Snippets](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#tracking-snippets)
    - [Account Statistics](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#account-statistics)
    - [Analytics Sales Leads](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#analytics-sales-leads)
- [Sales & Marketing](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#main-content)

    - [Email Customisation & Branding](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#email-customisation-branding)
    - [Buy It Now](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#buy-it-now)
    - [Instant Access Links](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#instant-access-links)
    - [Search Engine Verification](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#search-engine-verification)
    - [Trials](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#trials)
    - [Personalised Content Notifications](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#personalised-content-notifications)
- [Content Discovery](https://guide.contentcatalyst.com/content-discovery?hsLang=en#main-content)

    - [Site Navigation](https://guide.contentcatalyst.com/content-discovery?hsLang=en#site-navigation)
    - [End-User Search](https://guide.contentcatalyst.com/content-discovery?hsLang=en#end-user-search)
    - [Categories & Tags](https://guide.contentcatalyst.com/content-discovery?hsLang=en#categories-tags)
    - [MyCatalyst](https://guide.contentcatalyst.com/content-discovery?hsLang=en#mycatalyst)
- [End-User Actions](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#main-content)

    - [Share Briefing](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#share-briefing)
    - [Ask The Analyst](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#ask-the-analyst)
    - [Collate & Export Content](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#collate-export-content)
    - [Share](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#share)
    - [Notes](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#notes)
    - [Translation](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#translation)
    - [User Profile](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#user-profile)
- [RabbitMQ](https://guide.contentcatalyst.com/rabbitmq?hsLang=en#main-content)

    - [How to Use Rabbit MQ](https://guide.contentcatalyst.com/rabbitmq?hsLang=en#how-to-use-rabbit-mq)
    - [RabbitMQ: Events](https://guide.contentcatalyst.com/rabbitmq?hsLang=en#rabbitmq-events)

- [Main Website](https://contentcatalyst.com/)
- [Go to Customer Portal](https://guide.contentcatalyst.com/tickets-view)
- [Release Notes](https://guide.contentcatalyst.com/release-notes)
- [Raise a Ticket](https://guide.contentcatalyst.com/tickets-view/new?)

[![CC logo blue-1 (1)](https://guide.contentcatalyst.com/hs-fs/hubfs/CC%20logo%20blue-1%20(1).png?width=100&height=44&name=CC%20logo%20blue-1%20(1).png "CC logo blue-1 (1)")](http://contentcatalyst.com)

Energise your insights

<https://www.linkedin.com/company/content-catalyst>

Copyright © 2025, Content Catalyst Ltd.