Object APIs
Overview
Objects can be managed programmatically through APIs, enabling external systems and internal automations to retrieve Object metadata, interact with Record data and respond to configuration and Record changes in near real time.
Each subpage focuses on a specific use case, such as Retrieving Object IDs or Details, Retrieving Object Options, or searching for Specific Objects or Contacts in the system.
How Objects & Contacts Are Exposed Programmatically
Kizen exposes Objects and Contacts through two layers of programmatic access:
Object-Level Access
Using APIs to access data at an Object-level allows you to better understand the data that exists in the system. You can:
Retrieve lists of Objects and their IDs
Retrieve Object metadata, including available options and custom fields
Inspect schema details to understand how data is structured
Search for a specific Object
APIs that access data at an Object-level are typically used for Object discovery, schema inspection, and configuration validation.
Record-Level Access
Using APIs to access data at a Record level allows you to work with Records that belong to a specific Object. Once an Object is identified, you can:
Create, update, retrieve, and search for Records
Work with field values
Synchronize data between systems
For more information, see Records APIs
Object APIs and Record APIs are designed to work together. Understanding Object structure is a prerequisite for safely and reliably working with Record data. For more information, see Object Data Model.
When to Use APIs
In general:
Use APIs for request-driven access to metadata and Record data when you need controlled retrieval, synchronization, or validation.
API Topics in this Section
The following Object API topics build on the concepts introduced here:
These topics focus on Object discovery and metadata, which are typically the first step in any integration involving Objects.
What’s Next
Review the individual topics in this section to learn how to work with specific Object or Contact endpoints. Each page includes an endpoint or event details, examples, and usage considerations.
Last updated
Was this helpful?