List Contacts

get

https://api.getknit.dev/v1.0/accounting.contact.list

Lists contacts in a paginated format with details such as ID, name, contact type, email, phone, and address information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
For schema of contact object refer - Contact Data Model
This API may not return all fields defined in the response schema; for additional details, use the Get Contact by Id API.

Supported Apps

Here is the list of apps that supports this API

App	App ID
Xero	`xero`
QuickBooks	`quickbooks`
Zohobook	`zohobook`
Microsoft Dynamics Business Central	`microsoft-dynamics-business-central`
Netsuite	`netsuite`
Wave	`wave`
Odoo Accounting Online	`odoo`
Sage 200 Standard	`sage200`

📘
To see the list of supported filters for an app, refer - ACCOUNTING List Contacts Filter Support Matrix

Query Params

type

string

enum

required

Allowed:

pageToken

string

Defaults to null

originData

boolean

Defaults to false

createdAfter

string

Filters contact which were created after the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

createdBefore

string

Filters contact which were created before the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

updatedAfter

string

Filters contact which were updated after the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

updatdBefore

string

Filters contact which were updated before the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

status

string

Filters contacts by one or more status. Supports multiple values as a comma-separated list. Example: status=ACTIVE,INACTIVE

name

string

Filters contacts by one or more name. Supports multiple values as a comma-separated list. Example: name=cdef,ghij

companyId

string

Filters contacts by one or more companyId. Supports multiple values as a comma-separated list. Example: companyId=56789,234567

Response

Supported Apps

200