Jump to Content
Home
Documentation
API Reference
Changelog
Subscribe to RSS feed
Become a partner
API Reference
Become a partner
Home
Documentation
API Reference
Changelog
Subscribe to RSS feed
eSign events (v1 Legacy)
All
Pages
Start typing to searchâŚ
JUMP TO
Start developing
Start developing with the API
Core Concepts
Authorization
Permissions
Testing
Rate limiting
Pagination
Object-based endpoints
Error handling
Webhooks
Getting started with Webhooks
Employee events
Time off events
Task events
Docs events
Workforce planning events
API calls for webhook v2 events
[ Legacy] Webhooks v1
Employee events (v1 Legacy)
Time off events (v1 Legacy)
Task events (v1 Legacy)
eSign events (v1 Legacy)
Employee data API
People
Search for employees
post
Read company employee fields by employee ID.
post
Update company employee.
put
Read the public profile section of all active employees.
get
Create company employee.
post
Revoke access to Bob for an employee.
post
Terminate company employee.
post
Invite an employee with a welcome wizard ID.
post
Set or update an employee's start date.
post
Read avatar for an employee email
get
Read avatar for an employee ID.
get
Upload employee's avatar by image url
put
Update an employee's email address.
put
Onboarding
Get a summary of all onboarding wizards.
get
Metadata
Get all employee fields.
get
Create a new field.
post
Update an existing field
put
Delete an existing field.
del
Get all company lists
get
Get a specific company list by name.
get
Add a new item to an existing list.
post
Update an existing item from a list.
put
Delete an item from an existing list.
del
Employee Tables
List work history for a list of employees
get
List the lifecycle history for a list of employees.
get
List employment history for a list of employees.
get
List payroll history (salaries) for a list of employees.
get
Search for actual payments
post
List employee's work history
get
Create a new work entry for a given employee.
post
Update a work entry in the employee's work history table.
put
Deletes a work entry from a given employee's work history.
del
List employee's employment history.
get
Creates a new employment entry for a given employee.
post
Update an employment entry from a given employee's employment history.
put
Deletes an employment entry from a given employee's employment history.
del
List employee's lifecycle status history.
get
List employee's salary history.
get
Creates a new salary entry for a given employee.
post
Deletes a salary entry from the employee's list.
del
Read payroll tables history.
get
List the employee's equity grants.
get
Creates a new equity grant for a given employee.
post
Updates an equity grant for an employee
put
Deletes an equity grant for an employee.
del
List employee's variable payments
get
Creates a new variable payment for a given employee.
post
Deletes a variable payment record for an employee.
del
List the employee's training records.
get
Creates a new training records for a given employee
post
Deletes any training records for an employee.
del
List employee's bank accounts
get
Create a new bank account entry for a given employee.
post
Update a bank account entry in the employee's bank accounts table.
put
Deletes a bank account entry from a given employee's bank accounts table.
del
Custom Tables
Read metadata of custom tables defined
get
Read metadata for specific custom table
get
Read all entries of the given custom table
get
Create new custom table entry
post
Update custom table entry.
put
Delete custom table entry
del
Time Off API
Time off requests
Submit a new time off request.
post
Get the details of an existing time off request.
get
Cancel an existing time off request
del
Get time off requests changes
get
Read a list of who's out of the office.
get
Read a list of who's out of the office today or on the specified date.
get
Time off balance
Get the balance for a given employee
get
Create a balance adjustment.
post
Time off policies
Get Policy type reason codes
get
Add a list of reason codes for a given policy type.
post
Get Policy type details
get
Get all policy types names.
get
Get Policy details.
get
Get a list of policy names for a given policy type.
get
Attendance API
Attendance
Import attendance data
post
Fetch attendance summaries
post
Fetch daily attendance breakdown
post
Projects
Get Project Metadata
get
Search Projects
post
Create Project(s)
post
Update Project
patch
Archive Project
patch
Restore Project
patch
Get Project Client Metadata
get
Search Project Clients
post
Get Project Task Metadata
get
Search Project Tasks
post
Create Project Task(s)
post
Archive Project Task
patch
Restore Project Task
patch
Update Project Task
put
Tasks API
Tasks
Read all open tasks.
get
Read tasks of a specific employee
get
Mark a task as complete
post
Reports API
Reports
Read company reports
get
Download the report by ID
get
Get the report download URL for polling
get
Download a report by the report name.
get
Docs API
Documents
Get list of folders with metadata
get
Download list of documents of an employee
get
Upload file from a URL to a Shared Folder
post
Upload file from a URL to a Confidential Folder
post
Upload File from a URL to a Custom Folder
post
Upload file to a Shared Folder
post
Upload File to a Confidential Folder
post
Upload File to a Custom Folder
post
Delete a Document from a Shared Folder
del
Delete a Document from a Confidential Folder
del
Delete a Document from a Custom Folder
del
Goals API
Goals
Get Goal Type Metadata
get
Get Goals Metadata
get
Get Key Results Metadata
get
Get Goal Cycle Metadata
get
Search Goal Types
post
Search Goals
post
Search Key Results
post
Search Goal Cycles
post
Create Goals
post
Update Goal Status
patch
Update Goal
patch
Delete Goal
del
Create Key Results
post
Update Key Results Progress
patch
Update Key Results Details
patch
Delete a Key Result
del
Job Catalog API
Job catalog
Read company job profiles
post
Get all job roles
get
Get all job families
get
Get all job family groups
get
Get job profiles metadata
get
Get job role metadata
get
Get job family metadata
get
Get job family group metadata
get
Workforce Planning API
Workforce Planning
Get all positions fields
get
Get all positions openings fields
get
Get all position budget fields
get
Read company positions
post
Read company positions openings
post
Read company positions budgets
post
Create Position
post
Create Position Opening
post
Update Position
patch
Update Position Opening
patch
Deletes Position Opening
del
Create Position Budget
post
Update Position Budget
patch
Schedule Positions Cancellation
post
Cancel Position
patch
Bob Hiring API
Hiring
Get all active job ads from your Career page
post
Get the details of a single job ad
get
eSign events (v1 Legacy)
Ask AI
