Skip to main content
GuideCX is a customer onboarding and project management platform designed for implementation teams. Connect Humm to search projects, milestones, tasks, and notes to understand customer implementation progress.

​
Tools

ToolDescription
GUIDECX_SEARCH_PROJECTSSearch projects with filtering by customer name, status, or custom properties
GUIDECX_SEARCH_MILESTONESSearch milestones with optional project filtering
GUIDECX_SEARCH_TASKSSearch tasks with filtering by project, name, or status
GUIDECX_SEARCH_NOTESSearch notes by project or task
GUIDECX_LIST_USERSList all users in the workspace

​
Filter Behavior

​
Case Sensitivity

All GuideCX filters are case-sensitive. If no results are returned, verify the exact casing: 
# These are all different searches:
customerName = "Acme"
customerName = "acme"
customerName = "ACME"
Tip: Run a broad search first (no filters, limit=10) to see actual customer and project names, then refine with correct casing.

​
Partial Matching with like: Prefix

Text filters (customerName, name) automatically use GuideCX’s like: prefix for partial matching: 
# Searching for customerName = "Acme" matches:
- "Acme Corp"
- "Acme Manufacturing, Inc."
- "The Acme Company"

# But NOT (wrong case):
- "acme corp"
- "ACME CORP"

​
Custom Property Filtering

Projects can have custom properties (e.g., HubSpot Company ID, Salesforce Account ID). Use propsFilter to filter by these values.

​
Discovering Custom Properties

First, search projects without filters to inspect the properties object: 
GUIDECX_SEARCH_PROJECTS(limit=10)

# Response includes:
{
  "projects": [{
    "name": "Acme Implementation",
    "properties": {
      "hubspotCompanyId": "12345",
      "salesforceAccountId": "001ABC123",
      "region": "EMEA"
    }
  }]
}

​
Filtering by Custom Properties

Once you know the property name, use propsFilter: 
GUIDECX_SEARCH_PROJECTS(
  propsFilter = {
    "name": "hubspotCompanyId",
    "value": "12345"
  }
)
This maps to GuideCX’s props[hubspotCompanyId]=12345 query syntax.

​
Status Values

​
Project Statuses

StatusDescription
ON_TIMEProject is on schedule
LATEProject is behind schedule
ON_HOLDProject is paused
DONEProject is complete
NON_RESPONSIVECustomer is not responding
CANCELLEDProject has been cancelled

​
Task Statuses

StatusDescription
NOT_STARTEDTask has not begun
WORKING_ON_ITTask is in progress
DONETask is complete
STUCKTask is blocked
SIGN_OFFTask awaiting sign-off
NOT_APPLICABLETask does not apply
NOT_SCHEDULEDTask has no scheduled date
SCHEDULEDTask is scheduled

​
Authentication

API Token

Connect using a GuideCX API Bearer Token. Obtain your token from the GuideCX workspace admin portal.