Jump to Content

Guides API Endpoints

Home Guides Recipes API Endpoints Changelog

v1

Guides API Endpoints Log In

API Endpoints

Current

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 Employeedelete
Add Employee to Grouppost
Remove Employee from Groupdelete
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
Configure E-Verify Accountpost

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
Get Admin Detailsget
Create Adminpost
Update Adminpatch
Delete Admindelete
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

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

Powered by

List Documents

get https://yoursubdomain.workbright.com/api/documents

Retrieve all Documents in an account.

Language

Credentials

Header