Skip to main content

GUIDEcx Open API (3.0)

Learn how you can leverage data from outside systems and data from GUIDEcx projects with GUIDEcx Open API (3.0)

Written by Elan Maynez

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:

  1. Review the official API documentation

  2. Generate or obtain your API credentials (read below to learn how)

  3. Identify the workflows or systems you want to connect

  4. Test your integration in a safe environment

  5. 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

  1. As an Admin - go to Company Settings

  2. Navigate to API

  3. Click on Go to new API Authentication method

  4. Click on + Generate Token

  5. Name 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.

How the API Works

The GUIDEcx Open API uses standard HTTPS REST endpoints and JSON payloads.

A typical integration flow includes:

  1. Generate an API key in GUIDEcx

  2. Authenticate requests using a Bearer token

  3. Send requests to API endpoints

  4. Receive structured JSON responses

  5. Process or store returned data in your external system

The API follows standard REST conventions, including:

  • GET for retrieving data

  • POST for creating records

  • PUT/PATCH for updates

  • DELETE for removals

1. Authentication & Security

All API requests require authentication using a Bearer token. API keys are generated within GUIDEcx and can be scoped to specific permissions and resources.

This allows organizations to follow security best practices by granting integrations only the access they need.

Expected Behavior

  • Requests without a valid API key will fail with authentication errors.

  • Scoped API keys can only access permitted resources.

  • Full-access keys bypass scope restrictions.

  • API keys should be stored securely and never exposed publicly.

2. API Permissions & User Access

API behavior is tied closely to GUIDEcx permissions and visibility rules. Data returned by the API is subject to the same access restrictions configured within GUIDEcx user roles and project permissions.

For example:

  • Internal users may have broader access to projects and tasks.

  • External customers and third parties may only see assigned or visible tasks.

  • Hidden tasks and internal-only information are not exposed to users without permission.

When building integrations, it is important to understand how GUIDEcx permission models impact API responses.

Expected API Behavior

When working with the GUIDEcx Open API, you should expect the following behaviors:

1. Real-Time Data Access

API requests retrieve current GUIDEcx data at the time of the request. Changes made in GUIDEcx are reflected in future API calls.

2. Standard HTTP Responses

The API uses conventional HTTP status codes, including:

  • 200 — Successful request

  • 201 — Resource created

  • 401 — Authentication failed

  • 403 — Permission denied

  • 404 — Resource not found

  • 429 — Rate limit exceeded

  • 500 — Server error

3. JSON Responses

Responses are returned in JSON format for easy integration with other systems and applications.

4. Permission-Aware Results

Users and API keys only retrieve data they are authorized to access. Missing or filtered records are often related to permissions or project visibility settings.

5. Validation Enforcement

Invalid or incomplete payloads may return validation errors if required fields or formats are missing.

Best Practices

To build reliable integrations, GUIDEcx recommends following standard API best practices:

1. Use Scoped API Keys

Limit API access to only the resources and actions required for the integration.

2. Handle Errors Gracefully

Always account for failed requests, permission issues, and temporary outages within your integration logic.

3. Avoid Excessive API Calls

Batch requests where possible and design integrations efficiently to reduce unnecessary API traffic.

4. Protect Sensitive Data

Do not expose API keys in frontend applications, browser code, or public repositories.

5. Test in a Safe Environment

Before deploying production automations, validate workflows in a staging or test environment whenever possible.

6. API Documentation

Full endpoint documentation, request examples, authentication details, and schema references are available in the official GUIDEcx API documentation:

GUIDEcx Open API Documentation

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.

Related Articles
Connecting to your GUIDEcx Instance in Recipe Builder
What is the GUIDEcx Recipe Builder?
Did this answer your question?