How to get the list of Accounts

You can use the following to fetch the list of accounts 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_account_info`	`info`
`crm_account_addresses`	`addresses`
`crm_account_phones`	`phones`
`crm_account_contacts`	`contacts`	Get the contacts associated with an account, if the account represents an organization
`crm_account_custom_fields`	`customFields`
`User Mapped Fields`	`userMappedFields`	Field Mappings done via Mapping Presets

🚧
Some CRMs might allow Person Accounts
Typically, CRMs might represent organizations as accounts.
However, some CRMs, like Salesforce, might have the option to create a Person Account which acts as an account that belongs to a particular person without having any company associated with it. A Person Account would have an account, as well as a contact associated to it.
To know whether an account is a Person Account or not, you should refer to the isPersonAccount flag in the crm_account_info model below.

Account Info

Model ID: crm_account_info

Name	Type	Description
`id`	`String`
`name`	`String`
`description`	`String`
`industry`	`String`
`website`	`String`
`numberOfEmployees`	`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
`socialMediaLinks`	`List[String]`
`updatedAt`	`Date`
`createdAt`	`Date`
`lastActivityAt`	`Date`
`isPersonAccount`	`Enum`	Indicates whether the account is a Person Account type One of `TRUE`, `FALSE`, `NOT_SPECIFIED`

Account Addresses

Model ID: crm_account_addresses

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

Account Phones

Model ID: crm_account_phones

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

Account Contacts

Model ID: crm_account_contacts

Name	Type	Description
`contacts`	`List[String]`	Contact IDs associated with the account

Custom Fields

Model ID: crm_account_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

{
      "id": "15913301322",
      "name": "Waystar Royco",
      "description": "Multiple diversified businesses in the fields of Media, Entertainment, Parks/Cruises, and others",
      "industry": "Entertainment",
      "website": "waystarroyco.com",
      "numberOfEmployees": 1000.0,
      "owner": {
        "id": "407425865",
        "email": "sales@gojo.com"
      },
      "createdBy": {
        "id": "407425865",
        "email": "sales@gojo.com"
      },
      "socialMediaLinks": [
        "twitter.com/waystar",
        "linkedin.com/waystar"
      ],
      "updatedAt": "2023-05-31T11:09:59Z",
      "createdAt": "2023-05-31T11:09:53Z",
      "lastActivityAt": "2023-05-31T11:09:53Z",
      "isPersonAccount": "FALSE"
    },
    "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": "48562336"
      }
    ],
    "contacts": [
      "151"
    ]
  }