Articles on: Integrations & Advanced Features

Access and Use API Keys in CxPlanner

Overview


How do I access and manage API keys in CxPlanner?


CxPlanner offers an API integration feature that allows you to connect with other tools and software. API keys are used to authenticate requests and define access levels to project data.


Only users with the company role Admin can access and manage API keys.


Do not share your API keys with anyone. They allow access to your company’s data.



When and why to use this


Use API keys when you want to automate workflows, integrate CxPlanner with external systems, or build custom scripts that interact with project data.


  • Requires your company to have the API static key plugin enabled
  • Choose from multiple key types based on access requirements
  • Access is controlled at both project and global levels
  • Keys can be used in development, reporting, and syncing systems


Steps to get your API key:


  1. Click on your avatar in the top-right corner of the platform.
  2. Select API Keys from the dropdown.

API area

  1. Select the type of API key you want to generate.
  2. Copy and securely store your key.



Behavior and results


CxPlanner supports three API key types, each with different levels of access:


API Key Type

Description

Developer READ

Can only read data. Requires user to have access to specific projects. Cannot make changes

Developer READ-WRITE

Can read and write data. Requires access to projects. Can assign API user to new projects

Developer GLOBAL

Full read/write access to all projects. Highest permission level


Rate limiting


  • The API allows up to 100 requests per minute (including both GET and POST).
  • If you exceed this threshold, the system will return a rate limiting response (HTTP 429).
  • For extended usage, contact support to request an increase in limits.



Troubleshooting


Problem

Cause

Solution

Can't access API settings

Not a company Admin

Request access from an existing Admin

API key not working

Plugin not enabled

Contact support to activate API plugin

Receiving rate limit errors

More than 100 requests per minute

Add throttling to your requests or contact support

Can't see all project data

Using limited key type

Use Developer GLOBAL key if appropriate



Quick facts


  • Requires: Company role Admin
  • Location: Avatar menu → API Keys
  • Affects: API integrations, external data syncs, reporting automations



Updated on: 07/25/2025

Was this article helpful?

Share your feedback

Cancel

Thank you!