Jump to Content

Home Guides API Reference Changelog Discussions

v1.0

Signup For Free

API Reference

Signup For Free

v1.0Home Guides API Reference Changelog Discussions

API Basics

API Environment and Version
Authentication of APIs and Webhooks
API Response Structure
Event Glossary

Apps on Knit

All Supported Apps
HRIS Apps
ATS Apps
Communication Apps
Assessment Apps
Electronic Signature Apps
Expense Management Apps
Subscription Management Apps
Accounting Apps
CRM Apps

Data Types

Data Types

Syncs

Sync Data Types
Start a Syncpost

Sync FILTERS

Update Sync Filterpost
Deactivate Sync Filterpost

HRIS, Directory and Payroll

Employee Data Models
Payroll APIs
- Payroll Data Models
- Employee Payroll APIget
Leave APIs
Attendance APIs
Compensation APIs
- Get Compensation Plansget
- Update Employee Compensationpost
Document APIs
Update Employee Detailspost
Create Employeepost
Get Positions Detailsget
List all companiesget
List All Departmentsget
List of value APIs
- List of valuesget
Termination APIs
- Terminate Employeepost
- Get Termination Reasonsget
Deductions

Applicant Tracking Systems

Job Data Models
Application Data Models
ATS APIs

Communication

Communication APIs

CRM

Account Data Models
Contact Data Models
Lead Data Models
Deal Data Models
Engagement Data Models
Account APIs
Contact APIs
Deal APIs
Lead APIs
Engagement APIs
Custom Objects APIs
- Custom Objects Schemas APIs
- Custom Objects Records
List all Fields for Standard Objectsget
List all Usersget

Accounting

Accounts Data Models
Contact Data Models
Invoice Data Models
Purchase Order Data Models
Payment Data Models
Journal Entry Data Models
Accounting APIs
Account APIs
- Create an Accountpost
- Update an Accountpost
Contact APIs
- Create a Contactpost
- Update a Contactpost
Invoice APIs
- Create an Invoicepost
- Update an Invoicepost
Payment APIs
- Create a Paymentpost
- Update a Paymentpost

ASSESSMENT

Get Assessments Typesget
Send Assessment Invitepost

Electronic signature

Send Document for Signingpost
Get Sign URLsget
Download Documentget
Send Reminder for Signingpost

Expense Management

Expense Data Models
Expense Management APIs

Subscription Management

Subscriptions Data Models
List Item Familiesget
List Item Pricesget
List Itemsget

Integration Metadata

Integration Metadata APIs

Auth UI Component

Auth Session Creation APIpost

Passthrough requests

App Base URLs
Passthrough Requestpost

Custom Fields

Get all Fieldsget
Add Custom Field Mappingpost
Delete Custom Field Mappingpost

Base API with Connector ID

Getting Started With Your API

Powered by

API Basics

API Environment and Version
Authentication of APIs and Webhooks
API Response Structure
Event Glossary

Apps on Knit

All Supported Apps
HRIS Apps
ATS Apps
Communication Apps
Assessment Apps
Electronic Signature Apps
Expense Management Apps
Subscription Management Apps
Accounting Apps
CRM Apps

Data Types

Data Types

Syncs

Sync Data Types
Start a Syncpost

Sync FILTERS

Update Sync Filterpost
Deactivate Sync Filterpost

HRIS, Directory and Payroll

Employee Data Models
Payroll APIs
- Payroll Data Models
- Employee Payroll APIget
Leave APIs
Attendance APIs
Compensation APIs
- Get Compensation Plansget
- Update Employee Compensationpost
Document APIs
Update Employee Detailspost
Create Employeepost
Get Positions Detailsget
List all companiesget
List All Departmentsget
List of value APIs
- List of valuesget
Termination APIs
- Terminate Employeepost
- Get Termination Reasonsget
Deductions

Applicant Tracking Systems

Job Data Models
Application Data Models
ATS APIs

Communication

Communication APIs

CRM

Account Data Models
Contact Data Models
Lead Data Models
Deal Data Models
Engagement Data Models
Account APIs
Contact APIs
Deal APIs
Lead APIs
Engagement APIs
Custom Objects APIs
- Custom Objects Schemas APIs
- Custom Objects Records
List all Fields for Standard Objectsget
List all Usersget

Accounting

Accounts Data Models
Contact Data Models
Invoice Data Models
Purchase Order Data Models
Payment Data Models
Journal Entry Data Models
Accounting APIs
Account APIs
- Create an Accountpost
- Update an Accountpost
Contact APIs
- Create a Contactpost
- Update a Contactpost
Invoice APIs
- Create an Invoicepost
- Update an Invoicepost
Payment APIs
- Create a Paymentpost
- Update a Paymentpost

ASSESSMENT

Get Assessments Typesget
Send Assessment Invitepost

Electronic signature

Send Document for Signingpost
Get Sign URLsget
Download Documentget
Send Reminder for Signingpost

Expense Management

Expense Data Models
Expense Management APIs

Subscription Management

Subscriptions Data Models
List Item Familiesget
List Item Pricesget
List Itemsget

Integration Metadata

Integration Metadata APIs

Auth UI Component

Auth Session Creation APIpost

Passthrough requests

App Base URLs
Passthrough Requestpost

Custom Fields

Get all Fieldsget
Add Custom Field Mappingpost
Delete Custom Field Mappingpost

Base API with Connector ID

Getting Started With Your API

Powered by

Document Data Model

Name	Type	Description
`id`	`String`
`category`	`String`
`fileName`	`String`
`comment`	`String`
`content`	`String`
`encoding`	`Enum`	One of `BASE64` , `NOT_SPECIFIED`
`url`	`String`