Authenticate requests to the Custom Objects API using your GHL API key. Include the key in the Authorization header as a Bearer token or in a dedicated x-api-key header, depending on your API docs.
Authenticate the Acronis side by generating and using a secure token from the Acronis portal. Store credentials safely and rotate access tokens regularly.
Core endpoints include: GET /objects/:key, GET /objects, GET /objects/:schemaKey/records/:id, GET /objects/:record.readonly, POST /objects/:schemaKey/records, PUT /objects/:schemaKey/records/:id, DELETE /objects/:schemaKey/records/:id, and objects/schema.write for schema management. Additional endpoints may exist; consult the API docs for the full, up-to-date list.
Trigger: When you need to fetch object data or inspect schemas without modifying data.
Actions: Use GET endpoints (GET /objects, GET /objects/:key, GET /objects/:schemaKey/records/:id, GET /objects/record.readonly) to retrieve data and metadata.
GET /objects/:key, GET /objects, GET /objects/:schemaKey/records/:id, GET /objects/record.readonly
Key fields: key, schemaKey, id, and object identifiers
Trigger: When you need to add new records or modify existing ones.
Actions: Use POST, PUT, and DELETE endpoints to manage records (POST /objects/:schemaKey/records, PUT /objects/:schemaKey/records/:id, DELETE /objects/:schemaKey/records/:id).
POST /objects/:schemaKey/records, PUT /objects/:schemaKey/records/:id, DELETE /objects/:schemaKey/records/:id
Key fields: schemaKey, id, and the record payload
Trigger: When you need to create or modify object schemas.
GET /objects, POST /objects/schema.write, GET /objects/:schemaKey, PUT /objects/schema.write/:id
Key fields: schemaKey and object/schema identifiers
Fast data synchronization without custom code via prebuilt endpoints.
Structured object schemas provide consistent field mappings across apps.
Auditable API activity and straightforward change tracking for compliance.
This glossary explains common terms: API endpoints, schemas, records, and authentication, and how they flow between GHL and APPNAME.
A specific URL path and HTTP method that performs an action on a resource.
A defined structure for objects and their fields that governs data storage and access.
The process of proving identity to authorize API requests, typically via API keys or tokens.
A single data item within a schema, identified by a unique ID.
Schedule periodic imports of object data to populate Acronis records without custom coding.
Push updates from Acronis back to GHL to keep both systems in sync.
Use logs and dashboards to monitor data quality and sync health.
Generate and securely store GHL API keys and Acronis credentials; configure initial permissions.
Create field mappings between GHL Custom Objects and Acronis data schemas.
Run tests, verify results in both systems, then switch to production mode.
No heavy coding is required to get started. You can use the prebuilt read endpoints in the Custom Objects API to fetch object data and definitions. For more advanced flows, a basic understanding of REST helps you customize requests and error handling.
Basic read operations rely on endpoints like GET /objects/:key to fetch a specific object and GET /objects to list all objects. To retrieve a single record use GET /objects/:schemaKey/records/:id. The objects/record.readonly endpoint provides read-only metadata when supported.
Authentication combines your GHL API credentials with the Acronis credentials. Include the GHL API key in the request header as a Bearer token or x-api-key, and obtain a valid token from the Acronis portal for calls that require APPNAME access.
Yes. Use POST to create records and PUT (or PATCH) to update them, then DELETE to remove if needed. Target the correct schema via /objects/:schemaKey/records and include all required fields in the payload.
Yes. A schema editor or predefined templates help map fields between GHL and APPNAME. You can create or adjust object schemas using objects/schema.write endpoints.
Rate limits depend on your plan and configuration. Implement exponential backoff retries and monitor API quotas to avoid throttling.
Historical data can be retrieved when supported by the underlying APPNAME schema. Use appropriate query parameters or record history endpoints to access past records.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
