Jump to Content

Home Guides API Recipes API Endpoints Product Changelog

v1

API Endpoints

CurrentHome Guides API Recipes API Endpoints Product Changelog

All

Pages

Start typing to search…

Employees

Employee object
Address object
GroupMembership object
Employee Types
List Employeesget
Get Employee Detailsget
Find Employee by Emailget
Create Employeepost
Create Employee Without Welcome Email
Create Employee Without Remote I-9 Enabled
Update Employeepatch
Update Remote I-9 for Employee
Delete Employeedel
Add Employee to Grouppost
Remove Employee from Groupdel
Activate an Employeepost
Deactivate an Employeepost
List Employee's E-Verify Casesget
Get Initial Access Sign In Linkget
Bulk Employee Onboarding Progresspost

Employment

Employment object
Get Employment Details for an Employeeget
Update Employmentpatch

ACCOUNT

Account Object
Address Object
Get Company Profileget
Update Company Profilepatch
E-Verify Account Object
Configure E-Verify Accountpost
Update E-Verify Accountpatch

Groups

Group object
List Groupsget

Custom Fields

CustomField object
FieldOptions object
List Custom Fieldsget

Submissions

Submission object
I9 Submissions
W4 Submissions (2020+)
W4 Submissions (Pre-2020)
W9 Submissions
Audit Log object
Get Submission Detailsget
List Current Submissions for an Employeeget
Submission Files and Attachments
- Get Main Submission Fileget
- Get Attachment Fileget
List Past Submissions for a Document Assignmentget
Accept a Submissionpatch
Reject a Submissionpatch
Request Remote Reverifypatch
Resolve Document Verificationspatch

ADMINS

Admin Object
Admin Roles
List Adminsget
List Managed Access Policiesget
Find Admin by IDget
Find Admin by Emailget
Get Admin Detailsget
Create Adminpost
Update Adminpatch
Delete Admindel
Promote Employee to Administrator Rolepost

Document Assignments

Document Assignment Object
Get Employee's Document Assignmentsget
Request New Submission(s)patch
Select Current Submissionpatch

Documents

Document object
List Documentsget

Document Group Assignments

Document Group Assignment Object
List Document Group Assignmentsget

E-Verify

E-Verify Case Object
List E-Verify Casesget
List E-Verify Cases that Require Actionget
Get E-Verify Caseget

Embedded

Request One-Time Access Token for Staffpost
Request One-Time Access Token for Adminpost
Signing In with a One-Time Access Token

EMBEDDED CUSTOM APP THEMING

Custom App Theme Object
List Custom App Themingget
Create Custom App Themingpost
Update Custom App Themingpatch
Delete Custom App Themingdel

Powered by

CustomField object

An object representing a custom field associated with employees.