Custom objects

A custom object is an object type you define yourself inside a group — Projects, Applications, Properties, or anything else your workflow needs.

Deals are the default object type in folk, but they are not a special case: a deal is simply the object type every group starts with. Everything below applies equally to deals and to the object types you create.

Object types

Object types are defined per group, like custom fields are. A “Hiring” group might define an “Applications” object type, while a “Real estate” group defines “Properties”. The two are independent, even inside the same workspace.

Each object type has its own set of custom fields. An “Applications” object can track a Status and an Interview date, while a “Properties” object tracks a Price and a Surface.

Object types are group specific. Two groups can each define an object type with the same name, and they will not share their custom fields.

Object fields

Whatever its type, every object has the same native fields:

• name: The name of the object.
• people: A list of people associated with the object.
• companies: A list of companies associated with the object.
• createdAt: The date and time the object was created.
• createdBy: The user who created the object.

Everything else is a custom field defined on the object type in its group.

Object relationships

People and companies

An object can reference one or more people and companies, shown in its people and companies arrays. An object can only reference contacts that belong to the same group.

People

Read more about people

Companies

Read more about companies

Group

Objects are created inside a group, and the group is what defines the object types available to them.

Groups

Read more about groups

Custom objects in the API

Every object type shares one set of endpoints, with the object type passed as a path parameter:

/v1/groups/{groupId}/{objectType}

Reading an application is the same request as reading a deal, with a different objectType:

GET /v1/groups/grp_bc984b3f-0386-434d-82d7-a91eb6badd71/Applications
GET /v1/groups/grp_bc984b3f-0386-434d-82d7-a91eb6badd71/Deals

The object types available in a group are returned by the List group custom fields endpoint, as the fields whose type is objectField.

Custom objects API

Read more about the custom objects endpoints