For AI agents: visit https://docs.checkhq.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Guides Reference Changelog API Upgrades

Guides Reference

v2025-01-01

Guides Reference Changelog API Upgrades

Reference

v2025-01-01

Check API

Introduction
Authentication
Versioning
Errors
- Error codes
- Errors during payroll preview

Check Components

Overview of Components
Setup Components
Company Components
Employee Components
Contractor Components
- Contractor Onboardpost
- Contractor Tax Documentspost
Integration Components

API Reference

Companies
Addresses
- Validate addresspost
Workplaces
Employees
Contractors
Bank Accounts
Net Pay Splits
Payrolls
Payroll Items
Contractor Payments
External Payrolls
Fulfillments
Pay Schedules
Benefits
Post-Tax Deductions
Company Benefits
Earning Rates
Earning Codes
Documents
Company Provided Documents
Forms
Payments
Taxes
Agencies
Tax Parameters
Tax Elections
Tax packages
Employee tax statements
Filings
Setup
Requirements
Report runs
Webhook configs
Webhook deliveries
Logs
Notifications
Communications
Usage
- List usage summariesget
- List usage recordsget
Integrations

List employees

get

https://sandbox.checkhq.com/employees

Returns a list of all employees. Employees will be returned from the list endpoint in alphabetical order, sorted by last name, first name.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

company

string

Return employees for this company ID.

limit

int32

Defaults to 25

Number of employees returned per page. The maximum value is 100.

workplace

string

Return employees who work at these workplaces (can be comma-separated list of workplace IDs)

active

boolean

Include employees only with a certain active status

array of strings

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

metadata

object

Return only results whose metadata contains every given key and value, for example metadata[external_id]=123. Pass keys using bracket notation. Multiple keys are combined with AND. Brackets must be URL-encoded in request URLs (metadata%5Bkey%5D=value).

Response

Updated 12 months ago