How to get the list of Employees

There are two ways to fetch the list of employees 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 employee information whenever needed.

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

Data Model

Model ID	Event Data Key	Description
`accounting_employee_info`	`info`

Employee Info

Model ID: accounting_employee_info

Name	Type	Description
`id`	`String`	Unique ID of the employee as defined in accounting app.
`firstName`	`String`
`lastName`	`String`
`linkedCompanyIds`	`List[String]`	Company Id associated with employee.
`emails`	`List[Email]`	Please refer to Email Model
`phones`	`List[Phone]`	Please refer to Phone Model
`status`	`Enum`	One of `ACTIVE` `INACTIVE` `NOT_SPECIFIED`
`gender`	`Enum`	One of `MALE` `FEMALE` `NOT_SPECIFIED` `NON_BINARY`
`employmentType`	`Enum`	One of `FULL_TIME` `CONTRACT` `NOT_SPECIFIED`

Event Data Example

{
      "info": {
      "id": "9547",
      "firstName": "Alice",
      "lastName": "Dev",
      "companyId": "3",
      "linkedCompanyIds": null,
      "emails": [
        {
          "type": "WORK",
          "email": "alic@knit.dev"
        }
      ],
      "phones": [
        {
          "type": "HOME",
          "phoneNumber": "6754986754"
        },
        {
          "type": "PERSONAL",
          "phoneNumber": "7865453245"
        },
        {
          "type": "PERSONAL",
          "phoneNumber": "6754342312"
        },
        {
          "type": "WORK",
          "phoneNumber": "8675452342"
        }
      ],
      "status": "ACTIVE",
      "gender": "MALE",
      "employmentType": "FULL_TIME"
    }

}