Quicklinks

Object Best Practices

Kizen uses globally unique identifiers (GUIDs) to identify all entities in the system (custom objects, fields, activities, clients, etc). Because these IDs are unique across the entire platform, they are not portable from business to business. If a configuration is exported and imported into another business, all the objects will be assigned new IDs.

When building integrations for Kizen using the API, it may be tempting to simply hard-code IDs into an application, such as the ID for an object, or the IDs of fields to be updated. However, this is brittle, not resilient to changes to the data model, and won’t work for applications or plugins meant to work with multiple businesses.

Instead of hard-coding IDs, consumers of the API should prefer to use metadata endpoints to look up IDs dynamically.

SeeĀ Retrieving Object Metadata for more information

Further Reading

API Names

Each object has an API name that is unique to the business.