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

All

Pages

Start typing to search…

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
Calendar Apps
Ticketing Apps
Meeting Apps
Email Apps

Data Types

Data Types

Syncs

Sync Data Types
Start a Syncpost
Pause a Syncpost
Update sync frequencypost

Sync FILTERS

Update Sync Filterpost
Deactivate Sync Filterpost

SYNC WATCH FIELDS

Get watch fieldsget
Update watch fieldspost
Deactivate watch fieldspost

Custom Syncs

Setup custom syncpost

HRIS, Directory and Payroll

Employee APIs
Payroll APIs
Leave APIs
Attendance APIs
Compensation APIs
- Get Compensation Plansget
- Update Employee Compensationpost
Document APIs
Termination APIs
- Terminate Employeepost
- Get Termination Reasonsget
Deductions APIs
Miscellaneous HRIS APIs

Applicant Tracking Systems

Applications APIs
Jobs APIs
Candidate APIs
Tags APIs
Notes APIs
Users APIs
- List all Usersget
- Get a User by IDget
Departments APIs
- List all Departmentsget
- Get a Department by IDget
EEOC APIs
- List all EEOCsget
- Get EEOCget
Miscellaneous ATS APIs
- List Rejection Reasonsget

Communication

Message APIs
- Send a messagepost
- Update a messagepost
Bot Command APIs
- Register Bot commandpost
User & Channel APIs

CRM

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

Accounting

Account APIs
Contact APIs
Invoice APIs
Payment APIs
Journal Entry APIs
Purchase Order APIs
Expense API
Vendor Credit APIs
Credit Note APIs
Accounting Employee APIs
Credit Card APIs
Item APIs
Miscellaneous Accounting APIs

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 APIs
Miscellaneous Expense APIs
- List Usersget
- Get Expense Categoriesget

Subscription Management

Subscriptions Data Models
List Item Familiesget
List Item Pricesget
List Itemsget

Calendar

Calendars APIs
Events APIs
Availability APIs
- Get availabilitypost
- Get freebusy slotspost

Meeting

Users APIs
- Get Usersget
- Get User By Idget
Meetings APIs
Transcript APIs
- Get Transcript For a Meetingget
- Get Transcript Metadata For a Meetingget

Ticketing

Tickets APIs
Accounts APIs
- Get Accountsget
- Get Account By Idget
Contacts APIs
- Get Contactsget
- Get Contact By Idget
Comments
- Get Comments for a Ticketget
- Add Comment to a Ticketpost
Tags
- Get Tagsget
Users
- Get Usersget
- Get User By Idget
Groups
- Get Groupsget
- Get Group By Idget
Ticket Types
- Get All Ticket Typesget
Collections
- Get Collectionsget

Emails

Messages
Threads
Folders
Attachments
- Get attachment metaData by Idget
- Get Attachment Content by Idget
Drafts

Integration Metadata

Get List of Supported Appsget
Client OAuth Credentials APIpost
Get Integration Detailsget
Deactivate Integrationpost

Auth UI Component

Auth Session Creation APIpost

Passthrough requests

Passthrough Requestpost

Real Time Events

Subscribe to Real Time Eventspost

Custom Fields

Get all Fieldsget
Add Custom Field Mappingpost
Delete Custom Field Mappingpost

AI Connectors

Execute Connectorpost
Execute Use Casepost

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`