Creating an API Key | Civio Engage Knowledge Base       [ ![Civio Knowledge Base](/civio-light.svg) ](https://nginx.deploy-lagoon-production.civio-engage-docs.dh1.amazee.io)  [Articles](/articles) [Releases](/releases)

   [Home](/)   [Knowledge base](/articles)   [🛠️ Setting up Civio Engage ](/articles?category=2)

Creating an API Key
===================

Updated 1 week ago

    Search  Go

   API keys allow you to securely access Civio Engage's data through our API endpoints for integration with external platforms and services. This article explains how to create and manage API keys for your Civio Engage site.

**Administrator Access Required:** Only users with administrator permissions can create and manage API keys. API keys inherit the same permissions as the user who created them.

### What are API Keys?

API keys are secure authentication tokens that allow external applications to access your Civio Engage data programmatically. They enable you to:

- Integrate Civio Engage data with external systems
- Automate data collection and reporting processes
- Build custom applications that interact with your engagement platform
- Export data for analysis in third-party tools

### How to Create an API Key

Follow these steps to create a new API key for your Civio Engage site:

1. Log into your Civio Engage admin dashboard as an administrator.
2. Click on your user profile dropdown menu in the top-right corner of the screen.
3. Select **API** from the dropdown menu.
4. Provide a descriptive name for your API key in the **New token** form (e.g., "Marketing Integration", "Analytics Export").
5. Click **Create token** to generate your new API key.
6. **Important:** Copy and securely store your API key immediately. For security reasons, you won't be able to view the full key again after leaving this page.

### Accessing API Documentation

Civio Engage provides comprehensive, interactive API documentation that's automatically generated from the code:

1. While logged into your Civio Engage site as an administrator, view `/docs/api` e.g.
2. Browse available endpoints organised by functionality (Projects, Surveys, Maps, etc.)
3. Test endpoints directly in the documentation interface
4. View detailed request and response examples for each endpoint

#### Live Documentation

The API documentation is generated directly from the code, so it's always up-to-date with the latest available endpoints and features.

![](/storage/articles/13526984744463.png)

### API Key Permissions

API keys inherit the same permissions as the user account that created them. This means:

- Your API key can only access data that your user account has permission to view
- Project-specific permissions are respected - you can only access projects you have access to
- Team-based restrictions apply if your site uses team functionality
- Content moderation settings are enforced through the API

**Example:** If your user account can only access certain projects, your API key will only be able to retrieve data from those same projects through API calls.

### Using Your API Key

Once you've created your API key, you can use it to authenticate API requests. The key should be included in the Authorization header of your HTTP requests:

Authorization: Bearer YOUR\_API\_KEY\_HERE

#### Security Best Practices

- **Store your API key securely** - Never share it publicly or include it in client-side code
- **Use descriptive names** - This helps you identify and manage multiple keys
- **Revoke unused keys** - Regularly review and remove API keys that are no longer needed
- **Monitor usage** - Keep track of which applications are using each key

#### Need Help?

If you encounter any issues creating or using API keys, please reach out to the [Civio Engage Support Team](mailto:support@civ.io) for assistance.

 [    Back to articles ](/articles)

  Table of contents
-----------------

    © 2026 [Civio](https://civ.io) [Privacy Policy](/articles/privacy-policy) [Terms of Use](/articles/terms-of-use)