Objects

Custom Objects are how data is modeled in Kizen. Custom objects can optionally include workflow data.

The following default fields make up a custom object:

Field Name	Type	Notes
Name	Text	The name of the entity
Owner	Team Selector	A single-select of all team members in your business
Date Created	DateTime

Objects with Workflows

When a custom object has a workflow, this introduces the concept of a record “stage”. When an object has stage information, a board view becomes available in the UI to view your records on a Kanban board according to their current stage.

The following additional default fields are enabled on objects with a workflow:

Field Name	Type	Notes
Value	Money	Conditionally available, only if "Track Entity $ Value" is enabled for the object.
Stage	Stage	Required. Default value is the first stage in the pipeline for the object.
Estimated Close Date	DateTime
Actual Close Date	DateTime	Read-Only in the UI. The value is set automatically when the entity is moved to a closed/won stage.
Percentage Chance to Close - Low	Decimal	Conditionally available, if "Include % Chance to Close" is enabled for the object. Range from 0 to 1.
Percentage Chance to Close - High	Decimal	Conditionally available, if "Include % Chance to Close" is enabled for the object. Range from 0 to 1.
Reasons Lost	Dropdown	Conditionally available, if the entity is in a "Lost" stage in the pipeline.

Contact Object

The contact object (sometimes referred to as the client object) is a special object that has default fields for storing personal information for individuals.

Contact object default fields:

Field Name	Type	Notes
First Name*	Text
Last Name*	Text
Email*	Email	Must be unique across all contact records.
Business Phone	Phone
Mobile Phone*	Phone
Home Phone	Phone
Titles	Dynamic Tag
Tags	Dynamic Tag
Birthday	Date
Email Status	Dropdown	Options are fixed and cannot be changed.
Timezone	Timezone	Special dropdown of fixed timezone options.
Full Name	Calculated Value	This value is calculated by concatenating the first and last name fields. Cannot be independently changed.
Date Created	DateTime	Immutable, and set automatically.

* For contact records, at least one of the following fields is required to be filled out: First Name, Last Name, Email, or Mobile Phone Number.

Retrieving Object Metadata

To fetch the metadata for a custom object, make a GET call to /api/custom-objects/{object_identifier}. This API endpoint will return owner and access data for the object, as well as metadata about fields, relationships, and pipeline stages if applicable:

curl -X GET "https://app.go.kizen.com/api/custom-objects/{object_identifier}" \
 -H 'accept: application/json'