Standard objects and attributes

Overview

Unify provides a set of standard objects that ship with built-in attributes. The most commonly used standard objects are Company, Person, Opportunity, and User, documented below. Each attribute has an API name (used in API requests and responses) and a value type. You can extend any standard object with custom attributes, and you can link objects to one another with reference attributes.

These tables list the attributes that ship by default. A workspace may add custom attributes, so for the authoritative, live set on an object, list its attributes via the API:

GET /data/v1/objects/{object_name}/attributes

A few attributes are read-only and maintained by Unify. They appear in records and query results but cannot be set directly through the API.

Company

The Company object (company) represents an organization or business entity, such as a customer, competitor, or partner.

API name	Value type	Required	Description
`name`	Text		Name of the company.
`domain`	URL	Yes	Website domain. Normalized and deduplicated — see the note below.
`description`	Text		Description of the company.
`industry`	Text		Industry the company operates in.
`employee_count`	Integer		Estimated employee count.
`revenue`	Currency		Estimated revenue.
`founded`	Date		Date the company was founded.
`address`	Address		Physical address of the company.
`time_zone`	Time zone		Time zone the company is located in.
`corporate_phone`	Phone number		Corporate phone number.
`linkedin_url`	URL		LinkedIn company profile. Standardized to `https://www.linkedin.com/company/<handle>/`.
`status`	Text		Status of the company.
`lead_source`	Text		Source of the company record.
`do_not_contact`	Boolean		Whether contacting this company is disallowed.
`record_owner`	Reference		The user that owns the record. References the User object.
`hubspot_url`	URL		HubSpot record URL for the company.
`salesforce_url`	URL		Salesforce record URL for the company.
`last_activity_at`	Datetime		Last time any activity was recorded for the company. Read-only.
`last_website_activity_at`	Datetime		Last time a website activity was recorded for the company. Read-only.

The domain attribute has special validation and preprocessing to prevent duplicate company records. The domain is normalized (protocol and path are stripped). See Attribute value types for details.

Person

The Person object (person) represents an individual who interacts with your business, such as a prospect, customer, or contact at a partner company.

API name	Value type	Required	Description
`email`	Email address	Yes	Email address of the person.
`first_name`	Text		First name of the person.
`last_name`	Text		Last name of the person.
`title`	Text		Job title of the person.
`company`	Reference		Company the person is associated with. References the Company object.
`address`	Address		Physical address of the person.
`time_zone`	Time zone		IANA time zone identifier derived from the person’s address. Read-only.
`mobile_phone`	Phone number		Mobile phone number.
`work_phone`	Phone number		Work phone number.
`corporate_phone`	Phone number		Corporate phone number.
`phone_numbers`	Phone number		Additional phone numbers associated with the person. Returns a list.
`linkedin_url`	URL		LinkedIn profile. Standardized to `https://www.linkedin.com/in/<handle>/`.
`status`	Text		Status of the person.
`lead_source`	Text		Source of the person record.
`do_not_call`	Boolean		Whether calling this person is disallowed.
`do_not_email`	Boolean		Whether emailing this person is disallowed.
`email_opt_out`	Boolean		Whether the person has opted out of email communications.
`eu_resident`	Boolean		Whether the person is a resident of the European Union.
`record_owner`	Reference		The user that owns the record. References the User object.
`hubspot_url`	URL		HubSpot record URL for the person.
`salesforce_url`	URL		Salesforce record URL for the person.
`last_activity_at`	Datetime		Last time any activity was recorded for the person. Read-only.
`last_website_activity_at`	Datetime		Last time a website activity was recorded for the person. Read-only.

Opportunity

The Opportunity object (opportunity) represents a deal or potential business relationship. Opportunities can carry a monetary value and a stage, and can be linked to companies and people.

API name	Value type	Required	Description
`name`	Text	Yes	Name of the opportunity.
`uniqueness_key`	Text	Yes	Unique identifier used to distinguish this opportunity from others.
`amount`	Currency		Monetary value associated with the opportunity.
`stage`	Text		Stage of the opportunity in the sales process (such as “open” or “closed”).
`opportunity_type`	Text		Type of the opportunity.
`company`	Reference		Company associated with the opportunity. References the Company object.
`person`	Reference		Person associated with the opportunity. References the Person object.
`lead_source`	Text		Source of the opportunity.
`record_owner`	Reference		The user that owns the record. References the User object.
`original_created_at`	Datetime		Date when the opportunity was originally opened.
`hubspot_url`	URL		HubSpot record URL for the opportunity.
`salesforce_url`	URL		Salesforce record URL for the opportunity.

User

The User object (user) represents a member of your Unify workspace. Users are referenced by the record_owner attribute on other objects to indicate who owns a record.

API name	Value type	Required	Description
`email`	Email address	Yes	Email address of the user.
`first_name`	Text		First name of the user.
`last_name`	Text		Last name of the user.

Unlike other standard objects, the User object does not support custom attributes.

Unify Platform

Developer Guides

API Reference

SDKs

Standard objects and attributes

Overview

Company

Person

Opportunity

User

What’s next

Attribute value types

List attributes

​Overview

​Company

​Person

​Opportunity

​User

​What’s next

Attribute value types

List attributes

Overview

Company

Person

Opportunity

User

What’s next