How to get the list of Contacts

There are two ways to fetch the list of contacts from your integrations:

1. 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#/

2. Read APIs (On-demand Individual Reads)

Read APIs provide on-demand access to specific data through request-response calls. These are standard GET/List operations that allow you to retrieve contact information whenever needed.

You can refer to accounting APIs here: https://developers.getknit.dev/reference/list-contacts#/

Data Model

Model ID	Event Data Key	Description
`accounting_contact_info`	`info`
`accounting_contact_addresses`	`addresses`
`accounting_contact_phones`	`phones`
`accounting_contact_emails`	`emails`
`accounting_contact_users`	`users`	List of persons associated with contact

Contact Info

Model ID: accounting_contact_info

Name	Type	Description
`id`	`String`
`name`	`String`
`contactType`	`Enum`	One of `CUSTOMER`, `VENDOR`, `NOT_SPECIFIED`
`createdAt`	`Date`
`updatedAt`	`Date`
`status`	`Enum`	[`ACTIVE`, `INACTIVE`, `NOT_SPECIFIED`]
`accountNumber`	`String`
`companyId`	`String`
`linkedCompanyIds`	`List[String]`	List of company Ids associated with object. (Applicable for multi subsidiary apps like Netsuite.)
`currency`	`String`	One of among Currency Codes (ISO 4217) like- `INR`, `USD`, `EUR`
`taxNumber`	`String`
`urls`	`List[String]`	Social profile and website related URLs.

Contact Addresses

Model ID: accounting_contact_addresses

Name	Type	Description
`addresses`	`List[Address]`	Please refer to Address Model

Contact Phones

Model ID: accounting_contact_phones

Name	Type	Description
`phones`	`List[Phone]`	Please refer to Phone Model

Contact Emails

Model ID: accounting_contact_emails

Name	Type	Description
`emails`	`List[Email]`	Please refer to Email Model

Contact Users

Name	Type	Description
`accounting_contact_users`	`List[User]`	Please refer to User Model

Event Data Example

{
  "info": {
    "id": "02d528f1-89f2-4086-bbf2-6becd6ec407a",
    "name": "Updesh Test Accounting",
    "contactType": "CUSTOMER",
    "createdAt": "2024-05-23T12:42:34Z",
    "updatedAt": "2024-05-23T12:42:34Z",
    "status": "ACTIVE",
    "accountNumber": "1-030303032",
    "companyId": "ac19c8f9-a901-4db3-bef1-5aaca2a7c15a",
    "currency": "USD",
    "taxNumber": "GST-12339",
    "urls": [
      "https://getknit.dev",
      "https://xero.accounting.com"
    ]
  },
  "emails": [
    {
      "type": "WORK",
      "email": "updesh@knit.com"
    }
  ],
  "phones": [
    {
      "type": "PERSONAL",
      "phoneNumber": "91819119292"
    },
    {
      "type": "WORK",
      "phoneNumber": "9838783908"
    }
  ],
  "addresses": [
    {
      "addressLine1": "72/1A Church Street",
      "addressLine2": "Texas USA",
      "city": "Texas",
      "state": "Atlanta",
      "country": "USA",
      "zipCode": "20203939",
      "addressType": "BILLING"
    },
    {
      "addressLine1": "72/1A",
      "addressLine2": "USA",
      "city": "Texas",
      "state": "Atlanta",
      "country": "USA",
      "zipCode": "20203939",
      "addressType": "SHIPPING"
    }
  ],
  "users": [
    {
      "id": "1920",
      "email": "kunal@knit.com"
    },
    {
      "id": "102",
      "email": "admin@knit.com"
    }
  ]
}