Jump to Content
Home
Guides
API Reference
Changelog
Discussions
v1.0
Signup For Free
API Reference
Search
Signup For Free
v1.0
Home
Guides
API Reference
Changelog
Discussions
Candidate Data Models
All
Pages
Start typing to search…
JUMP TO
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 Sync
post
Pause a Sync
post
Update sync frequency
post
Sync FILTERS
Update Sync Filter
post
Deactivate Sync Filter
post
SYNC WATCH FIELDS
Get watch fields
get
Update watch fields
post
Deactivate watch fields
post
Custom Syncs
Setup custom sync
post
HRIS, Directory and Payroll
Employee APIs
Employee Data Models
Create Employee
post
Update Employee Details
post
Payroll APIs
Payroll Data Models
Employee Payroll API
get
Get pay periods
get
Leave APIs
List all Leave Types
get
Leave Data Models
Leave Requests API
get
Leave Balance API
get
Create Leave Request for Employee
post
Attendance APIs
Attendance API
get
Add Attendance API
post
Timesheet Entries
get
Compensation APIs
Get Compensation Plans
get
Update Employee Compensation
post
Document APIs
Document Data Model
Employee Documents API
get
Upload Document for Employee
post
Get Document Categories
get
Termination APIs
Terminate Employee
post
Get Termination Reasons
get
Deductions APIs
List all company-wide deductions
get
Create a company-wide deduction
post
Update a company-wide deduction
post
Enroll Employee in Deduction
post
Unenroll Employee from Deduction
post
Update Deduction For Employee
post
Miscellaneous HRIS APIs
List all Values for a Field
get
List all Positions
get
List all Companies
get
List All Departments
get
Applicant Tracking Systems
Applications APIs
Application Data Models
List all Applications
get
Get an Application by ID
get
Create an Application
post
Update an Application
post
Update an Application's Current Stage
post
Delete an Application
post
Add Attachment to an Application
post
Reject an Application
post
Jobs APIs
Job Data Models
List all Jobs
get
Get a Job by ID
get
Create a Job
post
Candidate APIs
Candidate Data Models
List all Candidates
get
Search Candidates
post
Get a Candidate by ID
get
Tags APIs
Get Global Tags
get
Get Candidate Tags
get
Add a Tag to a Candidate
post
Notes APIs
List all Notes
get
Get a Note by ID
get
Create a Candidate Note
post
Users APIs
List all Users
get
Get a User by ID
get
Departments APIs
List all Departments
get
Get a Department by ID
get
EEOC APIs
List all EEOCs
get
Get EEOC
get
Miscellaneous ATS APIs
List Rejection Reasons
get
Communication
Message APIs
Send a message
post
Update a message
post
Bot Command APIs
Register Bot command
post
User & Channel APIs
List Channels
get
List DM Ids
get
Get DM Id from email
get
CRM
Account APIs
Account Data Models
Create an Account
post
Update an Account
post
Delete an Account
post
List Accounts
get
Get an Account by Id
get
Contact APIs
Contact Data Models
Create a Contact
post
Update a Contact
post
Delete a Contact
post
List Contacts
get
Get a Contact By Id
get
Deal APIs
Deal Data Models
Get All Deal Stages
get
Create a Deal
post
Update a Deal
post
Delete a Deal
post
List Deals
get
Get a Deal By Id
get
Lead APIs
Lead Data Models
Create a Lead
post
Update a Lead
post
Delete a Lead
post
List Leads
get
Get a Lead By Id
get
Engagement APIs
Engagement Data Models
Create an Engagement
post
Update an Engagement
post
Delete an Engagement
post
List Engagements
get
Get a Engagement By Id
get
Custom Objects APIs
Custom Objects Schemas APIs
List all Custom Object Schemas
get
Create a Custom Object Schema
post
Delete a Custom Object Schema
post
Update a Custom Object Schema
post
List all Fields for a Custom Object Schema
get
Add a Field to a Custom Object Schema
post
Update a Field for a Custom Object Schema
post
Remove a Field for a Custom Object Schema
post
Custom Objects Records
Custom Objects Records Data Model
Create Custom Object Record
post
Update Custom Object Record
post
Delete Custom Object Record
post
Miscellaneous CRM APIs
List all Users
get
List all Fields for Standard Objects
get
Accounting
Account APIs
Accounts Data Models
Create an Account
post
Update an Account
post
List Accounts
get
Get Account
get
Contact APIs
Contact Data Models
Create a Contact
post
Update a Contact
post
List Contacts
get
Get Contact
get
Invoice APIs
Invoice Data Models
Create an Invoice
post
Update an Invoice
post
Add attachment to Invoice
post
List Invoices
get
Get Invoice
get
Payment APIs
Payment Data Models
Create a Payment
post
Update a Payment
post
List Payments
get
Journal Entry APIs
Journal Entry Data Models
List Journal Entries
get
Get Journal Entry
get
Create Journal Entry
post
Purchase Order APIs
Purchase Order Data Models
Get Purcahse Order
get
List Purchase Orders
get
Expense API
Expense Data Models
Create an Expense
post
List Expenses
get
Get Expense
get
Add attachment to Expense
post
Vendor Credit APIs
Create Vendor Credit
post
Delete Vendor Credit
post
Get Vendor Credit by Id
get
List Vendor Credits
get
Update Vendor Credit
post
Allocate Vendor Credit to a Bill
post
Deallocate Vendor Credit
post
Credit Note APIs
Create Credit Note
post
Delete Credit Note
post
Get Credit Note by Id
get
List Credit Notes
get
Update Credit Note
post
Allocate Credit Note to an Invoice
post
Deallocate Credit Note
post
Accounting Employee APIs
Employee Data Models
List Employees
get
Get Employee
get
Credit Card APIs
Create Credit Card Transaction
post
Update Credit Card Transaction
post
List Credit Card Transactions
get
Get Credit Card Transaction
get
Delete Credit Card Transaction
post
Item APIs
Get Items
get
Create Item
post
update Item
post
Delete Item
post
Miscellaneous Accounting APIs
Get Companies Info
get
Get Tax Rates
get
Get Tracking Categories
get
List Currencies
get
ASSESSMENT
Get Assessments Types
get
Send Assessment Invite
post
Electronic signature
Send Document for Signing
post
Get Sign URLs
get
Download Document
get
Send Reminder for Signing
post
Expense Management
Expense APIs
Expense Data Models
Create an Expense
post
Update Expense Status
post
Update Report Status
post
Miscellaneous Expense APIs
List Users
get
Get Expense Categories
get
Subscription Management
Subscriptions Data Models
List Item Families
get
List Item Prices
get
List Items
get
Calendar
Calendars APIs
List all calendars
get
Get a single calendar
get
Create a calendar
post
Update a calendar
post
Delete a calendar
post
Events APIs
List all events
get
List instances for an event
get
Get a single event
get
Create an event
post
Update an event
post
Delete an event
post
Move an event
post
Send RSVP
post
Availability APIs
Get availability
post
Get freebusy slots
post
Meeting
Users APIs
Get Users
get
Get User By Id
get
Meetings APIs
Get Meetings
get
Get Meeting By Id
get
Create Meeting
post
Delete Meeting
post
Transcript APIs
Get Transcript For a Meeting
get
Get Transcript Metadata For a Meeting
get
Ticketing
Tickets APIs
Get Tickets
get
Get Ticket By Id
get
Create Ticket
post
Update Ticket
post
Accounts APIs
Get Accounts
get
Get Account By Id
get
Contacts APIs
Get Contacts
get
Get Contact By Id
get
Comments
Get Comments for a Ticket
get
Add Comment to a Ticket
post
Tags
Get Tags
get
Users
Get Users
get
Get User By Id
get
Groups
Get Groups
get
Get Group By Id
get
Ticket Types
Get All Ticket Types
get
Collections
Get Collections
get
Emails
Messages
List Messages
get
Get message by Id
get
Send Message
post
Update message
post
Delete Message
post
Threads
List Threads
get
Get thread by Id
get
Update thread
post
Delete thread
post
Folders
List Folders
get
Get folder by Id
get
Create folder
post
Update folder
post
Delete folder
post
Attachments
Get attachment metaData by Id
get
Get Attachment Content by Id
get
Drafts
List Drafts
get
Get draft by Id
get
Create draft
post
Send draft
post
Update draft
post
Delete draft
post
Integration Metadata
Get List of Supported Apps
get
Client OAuth Credentials API
post
Get Integration Details
get
Deactivate Integration
post
Auth UI Component
Auth Session Creation API
post
Passthrough requests
Passthrough Request
post
Real Time Events
Subscribe to Real Time Events
post
Custom Fields
Get all Fields
get
Add Custom Field Mapping
post
Delete Custom Field Mapping
post
AI Connectors
Execute Connector
post
Execute Use Case
post
Powered by
Candidate Data Models
Ask AI
