Contacts
Store customers and companies with tags, segments, and custom fields. This guide follows version 3.1.7 (03acdf712c).
For custom attributes, see Properties, Tags & Segments.
Module layout
backend/core-api/src/modules/contacts/:
graphql/schemas/{customer,company}.ts,resolvers/queries/{customer,company},mutations/{customer,company},customResolvers/.db/definitions/{customers,company}.ts,db/models/{Customers,Companies}.ts.trpc/{customer,company,index}.tsfor service-to-service reads.
Customers support visitor info, location, and customFieldsData; both types support tagIds and segment filtering. Search behavior is driven by token configs over name, email, phone, code, and visitor contact info.
Working with contacts
- Filter by
tagIds,segment, and custom-field values rather than duplicating records. - Keep
customerSearchTokenConfigbehavior in mind when debugging search: partial matches depend on the configured fields. - Use relations or conformities to link contacts to deals, tickets, and tasks instead of copying contact data into those records.
Verify
- Create a company and a customer linked to it.
- Tag them and confirm they appear in the matching segment.
- Update a custom field and confirm the change is visible through both GraphQL and the UI.
Source references
Was this helpful?