Object API Names
Audience: Developers and Solution Architects
Purpose: Explains how API names and object identifiers are used in Kizen to reference objects, fields, activities, and automations when interacting with the API.
Overview
Each object has an API name that is unique to the business. The API name is automatically derived from the object name, and is displayed in the object settings wizard as a read-only field.
Object Identifier
The object identifier is the primary way to interact with the API. The object identifier can be either the Object’s API name, or the Object ID.
The API name of a custom object is easily accessible in the UI when editing a custom object. Look for the read-only field “Object API Name”. This value can be used as the object identifier when using the API.
Additional API Names
In addition to objects, other types of data have API names associated with them as well:
Activities
Object Fields
Activity Fields
Automations
What's Next
Now that you understand how API names and object identifiers are used to reference objects and other entities in the Kizen API, the next step is learning how those identifiers are used to work with actual data.
In the next section, Records, you’ll learn how entity records represent instances of custom objects, how data is stored in Kizen, and where to find guidance on creating, retrieving, and searching records using the API.
Last updated
Was this helpful?