How to get the list of Contacts

You can use the following to fetch the list of contacts from your integrations:

Syncs (Webhook-based Bulk Reads)

Syncs provide an automated, push-based approach for bulk data retrieval. Once you set up a sync for an integration, Knit polls the source app for changes and sends updates straight to your webhook. This webhook-based model eliminates the need for you to continuously pull data.

Read more about syncs and webhooks here: https://developers.getknit.dev/docs/register-webhook-url#/

Data Model

Model ID	Event Data Key	Description
`crm_contact_info`	`info`
`crm_contact_addresses`	`addresses`
`crm_contact_phones`	`phones`
`crm_contact_emails`	`emails`
`crm_contact_custom_fields`	`customFields`
`User Mapped Fields`	`userMappedFields`	Field Mappings done via Mapping Presets

Contact Info

Model ID: crm_contact_info

Name	Type	Description
`id`	`String`
`firstName`	`String`
`lastName`	`String`
`description`	`String`
`industry`	`String`
`jobTitle`	`String`
`owner`	`User`	Please refer to https://developers.getknit.dev/reference/base-models#user
`createdBy`	`User`	Please refer to https://developers.getknit.dev/reference/base-models#user
`updatedAt`	`Date`
`createdAt`	`Date`
`lastActivityAt`	`Date`
`account`	`String`	The Account ID that is associated with the contact

Contact Addresses

Model ID: crm_contact_addresses

Name	Type	Description
`addresses`	`List[Address]`	Please refer to https://developers.getknit.dev/reference/base-models#address

Contact Phones

Model ID: crm_contact_phones

Name	Type	Description
`phones`	`List[Phone]`	Please refer to https://developers.getknit.dev/reference/base-models#phone

Contact Emails

Model ID: crm_contact_emails

Name	Type	Description
`emails`	`List[Email]`	Please refer to https://developers.getknit.dev/reference/base-models#email

Custom Fields

Model ID: crm_contact_custom_fields

All the custom/auto populated/calculated fields in the source CRM.

Name	Type	Description
`fields`	`Map<String, Object>`

❗️
If you're only interested in a subset of fields rather than all the fields, consider mapping the fields you want using Mapping Presets. Custom Fields often include large number of CRM calculated and auto updated fields which might lead to a huge volume in delta_syncs

User Mapped Fields

Edit Field Mappings from the Knit dashboard for each integrated account to get unmapped fields. Read more about it here: https://developers.getknit.dev/docs/get-custom-fields-sync

Name	Type	Description
`fields`	`Map<String, Object>`

Event Data Example

{
    "info": {
      "id": "101",
      "firstName": "Kendall",
      "lastName": "Roy",
      "description": "Senior Executive",
      "industry": "Entertainment",
      "jobTitle": "CEO",
      "owner": {
        "id": "407425865",
        "email": "[email protected]"
      },
      "createdBy": {
        "id": "51501658",
        "email": "[email protected]"
      },
      "updatedAt": "2023-05-23T12:04:54Z",
      "createdAt": "2023-05-23T12:04:54Z",
      "lastActivityAt": "2023-05-23T12:04:28Z",
      "account": "15913301322"
    },
    "addresses": [
      {
        "addressLine1": "125, 32nd Street",
        "addressLine2": "9th Avenue",
        "city": "New York City",
        "state": "New York",
        "country": "United States of America",
        "zipCode": "54AZ",
        "addressType": "NOT_SPECIFIED"
      }
    ],
    "phones": [
      {
        "type": "NOT_SPECIFIED",
        "phoneNumber": "45684332463"
      }
    ],
    "emails": [
      {
        "type": "NOT_SPECIFIED",
        "email": "[email protected]"
      }
    ]
  }