Object

Custom objects and relationships are available on Pro and Growth plans. Records can be fetched and manipulated via these endpoints, and definitions can be fetched to discover the available custom object types in the system.

Create a custom object record

object.create(, ) -> ObjectCreateResponse

POST/v1/objects/{entitySlug}/values

Get a custom object record

object.retrieve(, ) -> ObjectRetrieveResponse

GET/v1/objects/{entitySlug}/values/{id}

Update a custom object record

object.update(, ) -> ObjectUpdateResponse

POST/v1/objects/{entitySlug}/values/{id}

Delete a custom object record

object.delete(, ) -> ObjectDeleteResponse

DELETE/v1/objects/{entitySlug}/values/{id}

Restore a custom object record

object.restore(, ) -> ObjectRestoreResponse

POST/v1/objects/{entitySlug}/values/{id}/restore

List custom object records

object.list(, ) -> ObjectListResponse

GET/v1/objects/{entitySlug}

Get definitions for a custom object type

object.definitions() -> ObjectDefinitionsResponse

GET/v1/objects/{entitySlug}/definitions

List custom object types

object.list_definitions() -> ObjectListDefinitionsResponse

GET/v1/objects

Get field value history for a custom object record

object.field_history(, ) -> ObjectFieldHistoryResponse

GET/v1/objects/{entitySlug}/values/{id}/fields/{fieldKey}/history

ModelsExpand Collapse

class ObjectCreateResponse: …

id: str

Unique identifier for the entity.

created_at: str

ISO 8601 timestamp of when the entity was created.

fields: Dict[str, Fields]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

value: Optional[FieldsValue]

The field value, or null if unset.

One of the following:

str

float

bool

List[str]

class FieldsValueAddress: …

city: Optional[str]

City name.

country: Optional[str]

2-letter ISO 3166-1 alpha-2 country code.

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class FieldsValueFullName: …

first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 13 more]

The data type of the field.

One of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATE"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

"HTML"

http_link: Optional[str]

URL to view the entity in the Lightfield web app, or null.

relationships: Dict[str, Relationships]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

cardinality: str

Whether the relationship is has_one or has_many.

object_type: str

The type of the related object (e.g. account, contact).

values: List[str]

IDs of the related entities.

directions: Optional[RelationshipsDirections]

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

as_destination: RelationshipsDirectionsAsDestination

The current record is the destination (incoming) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: List[str]

IDs of the related entities in this direction.

as_source: RelationshipsDirectionsAsSource

The current record is the source (outgoing) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: List[str]

IDs of the related entities in this direction.

updated_at: Optional[str]

ISO 8601 timestamp of when the entity was last updated, or null.

external_id: Optional[str]

External identifier for the entity, or null if unset.

class ObjectDefinitionsResponse: …

field_definitions: Dict[str, FieldDefinitions]

Map of field keys to their definitions, including both system and custom fields.

description: Optional[str]

Description of the field, or null.

label: str

Human-readable display name of the field.

type_configuration: FieldDefinitionsTypeConfiguration

Type-specific configuration (e.g. select options, currency code).

currency: Optional[str]

ISO 4217 3-letter currency code.

handle_service: Optional[Literal["TWITTER", "LINKEDIN", "FACEBOOK", "INSTAGRAM"]]

Social platform associated with this handle field.

One of the following:

"TWITTER"

"LINKEDIN"

"FACEBOOK"

"INSTAGRAM"

multiple_values: Optional[bool]

Whether this field accepts multiple values.

options: Optional[List[FieldDefinitionsTypeConfigurationOption]]

Available options for select fields.

id: str

Unique identifier of the select option.

label: str

Human-readable display name of the option.

description: Optional[str]

Description of the option, or null.

parent_id: Optional[str]

For a dependent select, the ID of the option in the parent field named by typeConfiguration.parentFieldKey that owns this option. Absent for ordinary selects.

parent_field_key: Optional[str]

For a dependent select, the field key whose selected option determines which of this field’s options apply. Absent for ordinary selects.

unique: Optional[bool]

Whether values for this field must be unique.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 13 more]

Data type of the field.

One of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATE"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

"HTML"

id: Optional[str]

Unique identifier of the field definition.

read_only: Optional[bool]

true for fields that are not writable via the API (e.g. AI-generated summaries). false or absent for writable fields.

object_type: str

The object type these definitions belong to (e.g. account).

relationship_definitions: Dict[str, RelationshipDefinitions]

Map of relationship keys to their definitions. Self-referential relationships include optional directional metadata on the bare definition.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this is a has_one or has_many relationship.

One of the following:

"HAS_ONE"

"HAS_MANY"

description: Optional[str]

Description of the relationship, or null.

label: str

Human-readable display name of the relationship.

object_type: str

The type of the related object (e.g. account, contact).

id: Optional[str]

Unique identifier of the relationship definition.

directions: Optional[RelationshipDefinitionsDirections]

Directional metadata for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

as_destination: RelationshipDefinitionsDirectionsAsDestination

The current record is the destination (incoming) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

label: str

Human-readable display name for this endpoint direction.

as_source: RelationshipDefinitionsDirectionsAsSource

The current record is the source (outgoing) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

label: str

Human-readable display name for this endpoint direction.

class ObjectDeleteResponse: …

id: str

Unique identifier for the entity.

created_at: str

ISO 8601 timestamp of when the entity was created.

fields: Dict[str, Fields]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

value: Optional[FieldsValue]

The field value, or null if unset.

One of the following:

str

float

bool

List[str]

class FieldsValueAddress: …

city: Optional[str]

City name.

country: Optional[str]

2-letter ISO 3166-1 alpha-2 country code.

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class FieldsValueFullName: …

first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 13 more]

The data type of the field.

One of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATE"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

"HTML"

http_link: Optional[str]

URL to view the entity in the Lightfield web app, or null.

relationships: Dict[str, Relationships]

cardinality: str

Whether the relationship is has_one or has_many.

object_type: str

The type of the related object (e.g. account, contact).

values: List[str]

IDs of the related entities.

directions: Optional[RelationshipsDirections]

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

as_destination: RelationshipsDirectionsAsDestination

The current record is the destination (incoming) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: List[str]

IDs of the related entities in this direction.

as_source: RelationshipsDirectionsAsSource

The current record is the source (outgoing) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: List[str]

IDs of the related entities in this direction.

updated_at: Optional[str]

ISO 8601 timestamp of when the entity was last updated, or null.

external_id: Optional[str]

External identifier for the entity, or null if unset.

class ObjectFieldHistoryResponse: …

data: List[Data]

Recorded values for the field, newest first.

display_value: str

Human-readable rendering of the value (e.g. a select option label), suitable for display.

is_create: bool

True for the record’s original value. Only set when the full history fits in the response (never on a truncated/paginated page).

recorded_at: str

ISO 8601 timestamp of when this value was recorded.

value: Optional[DataValue]

The field value, or null if unset.

One of the following:

str

float

bool

List[str]

class DataValueAddress: …

city: Optional[str]

City name.

country: Optional[str]

2-letter ISO 3166-1 alpha-2 country code.

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class DataValueFullName: …

first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 13 more]

The data type of the field.

One of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATE"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

"HTML"

has_more: bool

Whether more history exists beyond this page.

next_cursor: Optional[str]

Cursor to pass as after to fetch the next page, or null when there are no more entries.

class ObjectListDefinitionsResponse: …

data: List[Data]

All object types available to the caller.

label: str

Human-readable display name.

object_type: str

The slug used to reference this object type in the API.

class ObjectListResponse: …

data: List[Data]

Array of entity objects for the current page.

id: str

Unique identifier for the entity.

created_at: str

ISO 8601 timestamp of when the entity was created.

fields: Dict[str, DataFields]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

value: Optional[DataFieldsValue]

The field value, or null if unset.

One of the following:

str

float

bool

List[str]

class DataFieldsValueAddress: …

city: Optional[str]

City name.

country: Optional[str]

2-letter ISO 3166-1 alpha-2 country code.

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class DataFieldsValueFullName: …

first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 13 more]

The data type of the field.

One of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATE"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

"HTML"

http_link: Optional[str]

URL to view the entity in the Lightfield web app, or null.

relationships: Dict[str, DataRelationships]

cardinality: str

Whether the relationship is has_one or has_many.

object_type: str

The type of the related object (e.g. account, contact).

values: List[str]

IDs of the related entities.

directions: Optional[DataRelationshipsDirections]

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

as_destination: DataRelationshipsDirectionsAsDestination

The current record is the destination (incoming) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: List[str]

IDs of the related entities in this direction.

as_source: DataRelationshipsDirectionsAsSource

The current record is the source (outgoing) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: List[str]

IDs of the related entities in this direction.

updated_at: Optional[str]

ISO 8601 timestamp of when the entity was last updated, or null.

external_id: Optional[str]

External identifier for the entity, or null if unset.

object: str

The object type, always "list".

total_count: int

Total number of entities matching the query.

minimum0

maximum9007199254740991

class ObjectRestoreResponse: …

id: str

Unique identifier for the entity.

created_at: str

ISO 8601 timestamp of when the entity was created.

fields: Dict[str, Fields]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

value: Optional[FieldsValue]

The field value, or null if unset.

One of the following:

str

float

bool

List[str]

class FieldsValueAddress: …

city: Optional[str]

City name.

country: Optional[str]

2-letter ISO 3166-1 alpha-2 country code.

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class FieldsValueFullName: …

first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 13 more]

The data type of the field.

One of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATE"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

"HTML"

http_link: Optional[str]

URL to view the entity in the Lightfield web app, or null.

relationships: Dict[str, Relationships]

cardinality: str

Whether the relationship is has_one or has_many.

object_type: str

The type of the related object (e.g. account, contact).

values: List[str]

IDs of the related entities.

directions: Optional[RelationshipsDirections]

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

as_destination: RelationshipsDirectionsAsDestination

The current record is the destination (incoming) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: List[str]

IDs of the related entities in this direction.

as_source: RelationshipsDirectionsAsSource

The current record is the source (outgoing) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: List[str]

IDs of the related entities in this direction.

updated_at: Optional[str]

ISO 8601 timestamp of when the entity was last updated, or null.

external_id: Optional[str]

External identifier for the entity, or null if unset.

ObjectRetrieveResponse

One of the following:

class Entity: …

id: str

Unique identifier for the entity.

created_at: str

ISO 8601 timestamp of when the entity was created.

fields: Dict[str, EntityFields]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

value: Optional[EntityFieldsValue]

The field value, or null if unset.

One of the following:

str

float

bool

List[str]

class EntityFieldsValueAddress: …

city: Optional[str]

City name.

country: Optional[str]

2-letter ISO 3166-1 alpha-2 country code.

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class EntityFieldsValueFullName: …

first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 13 more]

The data type of the field.

One of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATE"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

"HTML"

http_link: Optional[str]

URL to view the entity in the Lightfield web app, or null.

relationships: Dict[str, EntityRelationships]

cardinality: str

Whether the relationship is has_one or has_many.

object_type: str

The type of the related object (e.g. account, contact).

values: List[str]

IDs of the related entities.

directions: Optional[EntityRelationshipsDirections]

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

as_destination: EntityRelationshipsDirectionsAsDestination

The current record is the destination (incoming) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: List[str]

IDs of the related entities in this direction.

as_source: EntityRelationshipsDirectionsAsSource

The current record is the source (outgoing) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: List[str]

IDs of the related entities in this direction.

updated_at: Optional[str]

ISO 8601 timestamp of when the entity was last updated, or null.

external_id: Optional[str]

External identifier for the entity, or null if unset.

class Restricted: …

id: str

Unique identifier for the record, the same ID a full response carries.

restricted: RestrictedRestricted

Present only on a record the caller may know exists but not read. Check for it before reading fields or relationships, which a restricted record does not carry.

name: str

A label for the record’s type, such as “Restricted opportunity”. Never the record’s name.

reason: Literal["NO_ACCESS", "INHERITED"]

Why the record is restricted.

One of the following:

"NO_ACCESS"

"INHERITED"

class ObjectUpdateResponse: …

id: str

Unique identifier for the entity.

created_at: str

ISO 8601 timestamp of when the entity was created.

fields: Dict[str, Fields]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

value: Optional[FieldsValue]

The field value, or null if unset.

One of the following:

str

float

bool

List[str]

class FieldsValueAddress: …

city: Optional[str]

City name.

country: Optional[str]

2-letter ISO 3166-1 alpha-2 country code.

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class FieldsValueFullName: …

first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 13 more]

The data type of the field.

One of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATE"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

"HTML"

http_link: Optional[str]

URL to view the entity in the Lightfield web app, or null.

relationships: Dict[str, Relationships]

cardinality: str

Whether the relationship is has_one or has_many.

object_type: str

The type of the related object (e.g. account, contact).

values: List[str]

IDs of the related entities.

directions: Optional[RelationshipsDirections]

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

as_destination: RelationshipsDirectionsAsDestination

The current record is the destination (incoming) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: List[str]

IDs of the related entities in this direction.

as_source: RelationshipsDirectionsAsSource

The current record is the source (outgoing) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: List[str]

IDs of the related entities in this direction.

updated_at: Optional[str]

ISO 8601 timestamp of when the entity was last updated, or null.

external_id: Optional[str]

External identifier for the entity, or null if unset.