# Contact ## Definitions `contact.definitions() -> ContactDefinitionsResponse` **get** `/v1/contacts/definitions` Returns the schema for all field and relationship definitions available on contacts, including both system-defined and custom fields. Useful for understanding the shape of contact data before creating or updating records. See [Fields and relationships](/using-the-api/fields-and-relationships/) for more details. **[Required scope](/using-the-api/scopes/):** `contacts:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Returns - `class ContactDefinitionsResponse: …` - `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: Dict[str, Union[str, float, bool, 3 more]]` Type-specific configuration (e.g. select options, currency code). - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `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", ) contact_definitions_response = client.contact.definitions() print(contact_definitions_response.field_definitions) ``` ## Create `contact.create(ContactCreateParams**kwargs) -> ContactCreateResponse` **post** `/v1/contacts` Creates a new contact record. After creation, Lightfield automatically enriches the contact in the background. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `contacts:create` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `fields: Union[Dict[str, Union[str, float, bool, 3 more]]]` Field values for the new contact. System fields use a `$` prefix (e.g. `$email`, `$name`); custom attributes use their bare slug. Note: `$name` is an object `{ firstName, lastName }`, not a plain string. Call the [definitions endpoint](/api/resources/contact/methods/definitions) to discover available fields and their types. See [Fields and relationships](/using-the-api/fields-and-relationships/) for value type details. - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `SequenceNotStr[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `Iterable[object]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `Iterable[object]` - `Dict[str, object]` - `relationships: Optional[Union[Dict[str, Union[str, SequenceNotStr[str]]]]]` Relationships to set on the new contact. System relationships use a `$` prefix (e.g. `$account`); custom relationships use their bare slug. Each value is a single entity ID or an array of IDs. Call the [definitions endpoint](/api/resources/contact/methods/definitions) to list available relationship keys. - `Dict[str, Union[str, SequenceNotStr[str]]]` - `str` - `SequenceNotStr[str]` ### Returns - `class ContactCreateResponse: …` - `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: Union[str, float, bool, 3 more]` The field value, or null if unset. - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `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. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) contact_create_response = client.contact.create( fields={ "foo": "string" }, ) print(contact_create_response.id) ``` ## Update `contact.update(strid, ContactUpdateParams**kwargs) -> ContactUpdateResponse` **post** `/v1/contacts/{id}` Updates an existing contact by ID. Only included fields and relationships are modified. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `contacts:update` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `id: str` Unique identifier of the contact to update. - `fields: Optional[Union[Dict[str, Union[str, float, bool, 3 more]]]]` Field values to update — only provided fields are modified; omitted fields are left unchanged. System fields use a `$` prefix (e.g. `$email`); custom attributes use their bare slug. Note: `$name` is an object `{ firstName, lastName }`, not a plain string. Call the [definitions endpoint](/api/resources/contact/methods/definitions) for available fields and types. See [Fields and relationships](/using-the-api/fields-and-relationships/) for value type details. - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `SequenceNotStr[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `Iterable[object]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `Iterable[object]` - `Dict[str, object]` - `relationships: Optional[Union[Dict[str, RelationshipsUnionMember0RelationshipsUnionMember0Item]]]` Relationship operations to apply. System relationships use a `$` prefix (e.g. `$account`). Each value is an operation object with `add`, `remove`, or `replace`. - `Dict[str, RelationshipsUnionMember0RelationshipsUnionMember0Item]` - `add: Optional[Union[str, SequenceNotStr[str]]]` Entity ID(s) to add to the relationship. - `str` - `SequenceNotStr[str]` - `remove: Optional[Union[str, SequenceNotStr[str]]]` Entity ID(s) to remove from the relationship. - `str` - `SequenceNotStr[str]` - `replace: Optional[Union[str, SequenceNotStr[str]]]` Entity ID(s) to set as the entire relationship, replacing all existing associations. - `str` - `SequenceNotStr[str]` ### Returns - `class ContactUpdateResponse: …` - `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: Union[str, float, bool, 3 more]` The field value, or null if unset. - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `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. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) contact_update_response = client.contact.update( id="id", ) print(contact_update_response.id) ``` ## Retrieve `contact.retrieve(strid) -> ContactRetrieveResponse` **get** `/v1/contacts/{id}` Retrieves a single contact by its ID. **[Required scope](/using-the-api/scopes/):** `contacts:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Parameters - `id: str` Unique identifier of the contact to retrieve. ### Returns - `class ContactRetrieveResponse: …` - `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: Union[str, float, bool, 3 more]` The field value, or null if unset. - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `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. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) contact_retrieve_response = client.contact.retrieve( "id", ) print(contact_retrieve_response.id) ``` ## List `contact.list(ContactListParams**kwargs) -> ContactListResponse` **get** `/v1/contacts` Returns a paginated list of contacts. Use `offset` and `limit` to paginate through results. See [List endpoints](/using-the-api/list-endpoints/) for more information about pagination. **[Required scope](/using-the-api/scopes/):** `contacts:read` **[Rate limit category](/using-the-api/rate-limits/):** Search ### Parameters - `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 ContactListResponse: …` - `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: Union[str, float, bool, 3 more]` The field value, or null if unset. - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `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. - `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", ) contact_list_response = client.contact.list() print(contact_list_response.data) ``` ## Domain Types ### Contact Create Response - `class ContactCreateResponse: …` - `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: Union[str, float, bool, 3 more]` The field value, or null if unset. - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `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. ### Contact Definitions Response - `class ContactDefinitionsResponse: …` - `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: Dict[str, Union[str, float, bool, 3 more]]` Type-specific configuration (e.g. select options, currency code). - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `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. ### Contact List Response - `class ContactListResponse: …` - `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: Union[str, float, bool, 3 more]` The field value, or null if unset. - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `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. - `object: str` The object type, always `"list"`. - `total_count: int` Total number of entities matching the query. ### Contact Retrieve Response - `class ContactRetrieveResponse: …` - `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: Union[str, float, bool, 3 more]` The field value, or null if unset. - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `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. ### Contact Update Response - `class ContactUpdateResponse: …` - `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: Union[str, float, bool, 3 more]` The field value, or null if unset. - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `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.