# Object ## Create a custom object record `object.create(strentity_slug, ObjectCreateParams**kwargs) -> ObjectCreateResponse` **post** `/v1/objects/{entitySlug}/values` Creates a new record for the specified custom object type. ### Parameters - `entity_slug: str` The slug of the custom object type. - `fields: Dict[str, Optional[Fields]]` Field names to values for the new record. - `str` - `float` - `bool` - `Sequence[str]` - `class FieldsAddress: …` - `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 FieldsFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `relationships: Optional[Dict[str, Union[str, Sequence[str]]]]` Relationship names to entity ID(s) to associate. - `str` - `Sequence[str]` ### Returns - `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. - `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", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `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`). - `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. - `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. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) object_create_response = client.object.create( entity_slug="entitySlug", fields={ "foo": "string" }, ) print(object_create_response.id) ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## Get a custom object record `object.retrieve(strid, ObjectRetrieveParams**kwargs) -> ObjectRetrieveResponse` **get** `/v1/objects/{entitySlug}/values/{id}` Retrieves a single record by ID for the specified custom object type. ### Parameters - `entity_slug: str` The slug of the custom object type. - `id: str` The ID of the record to retrieve. ### Returns - `class ObjectRetrieveResponse: …` - `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. - `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", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `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`). - `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. - `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. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) object_retrieve_response = client.object.retrieve( id="id", entity_slug="entitySlug", ) print(object_retrieve_response.id) ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## Update a custom object record `object.update(strid, ObjectUpdateParams**kwargs) -> ObjectUpdateResponse` **post** `/v1/objects/{entitySlug}/values/{id}` Updates an existing record by ID for the specified custom object type. Only included fields and relationships are modified. ### Parameters - `entity_slug: str` The slug of the custom object type. - `id: str` The ID of the record to update. - `fields: Optional[Dict[str, Optional[Fields]]]` Field names to values. Only provided fields are modified. - `str` - `float` - `bool` - `Sequence[str]` - `class FieldsAddress: …` - `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 FieldsFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `relationships: Optional[Dict[str, Relationships]]` Relationship names to operations (`add`, `remove`, or `replace`). - `add: Optional[Union[str, Sequence[str]]]` Entity ID(s) to add to the relationship. - `str` - `Sequence[str]` - `remove: Optional[Union[str, Sequence[str]]]` Entity ID(s) to remove from the relationship. - `str` - `Sequence[str]` - `replace: Optional[Union[str, Sequence[str]]]` Entity ID(s) to set as the entire relationship, replacing all existing associations. - `str` - `Sequence[str]` ### Returns - `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. - `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", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `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`). - `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. - `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. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) object_update_response = client.object.update( id="id", entity_slug="entitySlug", ) print(object_update_response.id) ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## List custom object records `object.list(strentity_slug, ObjectListParams**kwargs) -> ObjectListResponse` **get** `/v1/objects/{entitySlug}` Returns a paginated list of records for the specified custom object type. Use `offset` and `limit` to paginate through results, and `$field` query parameters to filter. See [List endpoints](/using-the-api/list-endpoints/) for more information about [pagination](/using-the-api/list-endpoints/#pagination) and [filtering](/using-the-api/list-endpoints/#filtering). ### Parameters - `entity_slug: str` The slug of the custom object type. - `limit: Optional[int]` Maximum number of records to return. Defaults to 25, maximum 25. - `offset: Optional[int]` Number of records to skip for pagination. Defaults to 0. ### Returns - `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. - `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", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the entity in the Lightfield web app, or null. - `relationships: Dict[str, DataRelationships]` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `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. - `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. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) object_list_response = client.object.list( entity_slug="entitySlug", ) print(object_list_response.data) ``` #### Response ```json { "data": [ { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ], "object": "object", "totalCount": 0 } ``` ## Get definitions for a custom object type `object.definitions(strentity_slug) -> ObjectDefinitionsResponse` **get** `/v1/objects/{entitySlug}/definitions` Returns field and relationship definitions for the specified custom object type. ### Parameters - `entity_slug: str` The slug of the custom object type. ### Returns - `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. - `"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. - `unique: Optional[bool]` Whether values for this field must be unique. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` Data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `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. - `cardinality: Literal["HAS_ONE", "HAS_MANY"]` Whether this is a `has_one` or `has_many` relationship. - `"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. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) object_definitions_response = client.object.definitions( "entitySlug", ) print(object_definitions_response.field_definitions) ``` #### Response ```json { "fieldDefinitions": { "foo": { "description": "description", "label": "label", "typeConfiguration": { "currency": "currency", "handleService": "TWITTER", "multipleValues": true, "options": [ { "id": "id", "label": "label", "description": "description" } ], "unique": true }, "valueType": "ADDRESS", "id": "id", "readOnly": true } }, "objectType": "objectType", "relationshipDefinitions": { "foo": { "cardinality": "HAS_ONE", "description": "description", "label": "label", "objectType": "objectType", "id": "id" } } } ``` ## List custom object types `object.list_definitions() -> ObjectListDefinitionsResponse` **get** `/v1/objects` Returns all custom object types available to the caller. ### Returns - `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. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) object_list_definitions_response = client.object.list_definitions() print(object_list_definitions_response.data) ``` #### Response ```json { "data": [ { "label": "label", "objectType": "objectType" } ] } ``` ## Domain Types ### Object Create Response - `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. - `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", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `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`). - `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. - `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 Definitions Response - `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. - `"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. - `unique: Optional[bool]` Whether values for this field must be unique. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` Data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `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. - `cardinality: Literal["HAS_ONE", "HAS_MANY"]` Whether this is a `has_one` or `has_many` relationship. - `"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. ### Object List Definitions Response - `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. ### Object List Response - `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. - `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", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the entity in the Lightfield web app, or null. - `relationships: Dict[str, DataRelationships]` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `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. - `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. ### Object Retrieve Response - `class ObjectRetrieveResponse: …` - `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. - `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", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `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`). - `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. - `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 Update Response - `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. - `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", 11 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `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`). - `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. - `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.