Overview
The GUIDEcx Open API allows organizations to connect GUIDEcx with other business systems, automate onboarding workflows, and securely exchange project data across platforms. It gives teams the flexibility to extend GUIDEcx beyond the core application and build integrations that match their unique onboarding processes.
Whether you are syncing CRM data, triggering onboarding projects automatically, or building custom dashboards, the Open API helps create a more connected customer onboarding experience.
⚠️ IMPORTANT NOTE ⚠️ GUIDEcx Open API (3.0) is tied to GUIDE 2.0 data. You cannot use this API endpoint to retrieve legacy GUIDEcx data/projects - you'll need to use Open API (2.0)
What Is the GUIDEcx Open API?
The GUIDEcx Open API is a developer interface that provides programmatic access to GUIDEcx data and workflows. Through API endpoints, organizations can retrieve information from GUIDEcx, update records, and automate actions between systems.
This API-first approach supports scalable integrations and enables organizations to reduce manual work while improving onboarding visibility and consistency. Use the API to build advanced automations and AI-driven workflows.
Benefits of Using the Open API
Using the GUIDEcx Open API can help your team:
Reduce manual data entry
Automate onboarding project creation
Keep systems aligned across departments
Improve reporting and visibility
Create customized onboarding workflows
Build integrations tailored to your business needs
For many organizations, API integrations help streamline the transition from sales to onboarding while ensuring project data stays accurate across platforms.
Common Use Cases
Here are some common ways organizations use the GUIDEcx Open API:
CRM Integrations
Automatically create onboarding projects when deals are marked Closed Won in systems like Salesforce or HubSpot.
Reporting & Business Intelligence
Pull onboarding data into reporting tools or data warehouses for advanced analytics and operational insights.
Workflow Automation
Trigger notifications, update statuses, sync customer information, or automate repetitive onboarding tasks between systems.
Custom Integrations
Connect GUIDEcx with internal applications, support systems, ERP platforms, or third-party tools that are unique to your organization.
AI & Operational Automation
Leverage GUIDEcx onboarding data to support intelligent forecasting, resource planning, or AI-driven operational workflows.
API Access & Setup
API access is available within GUIDEcx company settings and is only managed by administrators (users with an Admin license). API management and token access are available through Company Details settings. Here's how to generate those credentials.
Depending on your GUIDEcx package, API access may be included as part of your plan. If you don't have access - reach out to your CSM!
Getting Started
To begin using the GUIDEcx Open API:
Review the official API documentation
Generate or obtain your API credentials (read below to learn how)
Identify the workflows or systems you want to connect
Test your integration in a safe environment
Deploy and monitor your automation workflows
For organizations building more advanced integrations, GUIDEcx also offers implementation guidance and professional services resources.
How to Generate API credentials
As an Admin - go to Company Settings
Navigate to API
Click on
Go to new API Authentication methodClick on
+ Generate TokenName the token and provide an easy to understand description
⚠️ IMPORTANT NOTE ⚠️ Tokens are tied to accounts. We recommend that you create an System Admin user that has Admin access and is used to generate API tokens. If API tokens are tied to an individual they will stop working if that user is ever deactivated.
Need Help Building an Integration?
If your team is planning a custom integration or advanced automation workflow, reach out to your Customer Success Manager to schedule time with the GUIDEcx Technical Services team. They can help review your use case, recommend best practices, and guide your implementation strategy.