Add an API User to a Project
Overview
How do I give an API user access to a specific project?
When using certain API integrations in CxPlanner, you must manually assign the API user to the relevant projects. This step ensures controlled access and data security.
When and why to use this
Adding an API user to a project is necessary to enable integrations or automations for that specific project.
- Required when using API keys with Developer READ or Developer READ-WRITE access
- Prevents API users from accessing unauthorized project data
- Gives you full control over which projects the API user can access
Steps to add an API user to a project:
- Go to the Project Settings of the target project.
- Navigate to the Team or Users section.
- Add the API user as a project member.
- Assign a suitable project role (Viewer is usually sufficient for API use).
Behavior and results
- API users are not granted project access automatically
- Manual assignment ensures data security and access control
- Only assigned projects will be accessible to API calls made using limited-scope API keys
API Key Type | Project Access Requirement | Behavior |
|---|---|---|
Developer READ | Required | Can read data only from assigned projects |
Developer READ-WRITE | Required | Can read/write to assigned projects and assign self to new ones |
Developer GLOBAL | Not required | Automatically has access to all projects |
Troubleshooting
Problem | Cause | Solution |
|---|---|---|
API user receives no data | Not added to the project | Manually assign user in Project Settings |
Access denied on API requests | Incorrect role or permissions | Assign appropriate access rights (e.g., Viewer or higher) |
User not found in dropdown | API user not yet created | Ensure the user exists in company settings |
Quick facts
- Requires: Project role Manager or Admin
- Location: Project Settings → Team or Users
- Affects: API access to specific project data
Updated on: 07/25/2025
Thank you!