Authenticate every request with a valid GHL access token, scoped to objects/schema.readonly for reads. Include the token in the Authorization header as Bearer
Obtain an access token via ActiveDEMAND’s OAuth flow and include it in the Authorization header for API requests to the Custom Objects API.
Endpoints include: GET /objects/:key to fetch a single object; GET /objects to list objects; objects/schema.write to update schemas; objects/record.readonly to read records; GET /objects/:schemaKey/records/:id to fetch a specific record; objects/record.write to modify records; POST /objects/:schemaKey/records to create; PUT /objects/:schemaKey/records/:id to update; DELETE /objects/:schemaKey/records/:id to delete. Additional endpoints may be provided as needed.
Trigger: when an object key is created or updated, fetch the latest data to enrich ActiveDEMAND records.
Actions: call GET /objects/:key to retrieve the object, then push relevant fields to ActiveDEMAND records or campaigns.
GET /objects/:key
key, last_modified, attributes
Trigger: schema changes detected in ActiveDEMAND trigger automatic updates of related objects.
Actions: read schema (objects/schema.*), fetch affected records, and apply updates via PUT/POST to maintain consistency.
GET /objects
schemaKey, id, records
Trigger: scheduled exports or on-demand bulk sync to move large datasets between systems.
Actions: use POST /objects/:schemaKey/records to create many records; PUT /objects/:schemaKey/records/:id to update; DELETE as needed; coordinate with ActiveDEMAND data maps.
POST /objects/:schemaKey/records
fields: all required schema fields such as name, key, value, and metadata
Fast setup with no custom coding required.
Automate data synchronization with triggers and actions in your workflows.
Leverage flexible object schemas to model your business data without writing a line of code.
This glossary defines core concepts: Object, Schema, Endpoint, Record, and the authentication and data flow steps used when connecting ActiveDEMAND with the Custom Objects API.
A named collection of fields describing a data type in the Custom Objects API.
A URL path that exposes a specific operation for objects and records.
The structure that defines fields and types for an object.
A single instance of an object stored in ActiveDEMAND via the API.
Automatically pull object data and enrich contact records in ActiveDEMAND as updates occur.
Trigger campaigns based on object changes, enabling personalized messaging.
Dashboards that visualize object schema data and related records.
Obtain an access token via ActiveDEMAND’s OAuth flow and include it in API requests.
Define your object schemas, and map endpoints to actions in your workflows.
Set up triggers, schedules, and automations to keep ActiveDEMAND and GHL in sync.
The GHL Custom Objects API is a RESTful interface that lets you manage custom object schemas and their records from within ActiveDEMAND. It supports reading and writing operations via endpoints such as GET /objects and POST /objects/:schemaKey/records. Security is enforced with OAuth tokens; grant the necessary scopes and pass the token in the Authorization header.
Authenticate using ActiveDEMAND’s OAuth flow to obtain an access token. Include the token in the Authorization header and refresh as needed. Ensure your client has the appropriate scopes for read and write operations.
Available endpoints include fetching objects, schemas, and records, as well as creating, updating, and deleting records. Refer to ENDPOINTLIST for a complete list and capabilities.
Yes. You can perform bulk operations by batching requests where supported, or by iterating multiple calls in a single automation. Use POST for creates, PUT for updates, and DELETE for removals as needed.
Object schemas define the fields and data types for a given object. They guide how you structure data and which endpoints are available for manipulating it.
Code is not strictly required. You can use no-code automation tools or cURL to call the API, though some apps may benefit from lightweight scripting for error handling.
To test connections, generate a test token and make sample requests to endpoints like GET /objects and GET /objects/:key, then review responses for correctness.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers