Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zeal Employees API

The Employees API from Zeal — 4 operation(s) for employees.

Zeal Employees API is one of 10 APIs that Zeal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Employees. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.zeal.com.

6 operations 4 paths 4 schemas 3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.zeal.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Zeal Employees API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Provide your Zeal API key as a Bearer token: Authorization: Bearer . Use a test key for Test Mode and a live key for production. Requests are additionally scop…

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Employees 6
POST
/employees
Create an employee
createEmployee body → 200
GET
/employees
Get employees
getEmployees 1 param → 200
PUT
/employees
Update employee information
updateEmployeeInformation body → 200
GET
/employees/onboarding
Generate an employee onboarding link
generateEmployeeOnboardingLink 2 params → 200
POST
/taxes/employee/setup
Set employee tax parameters
setEmployeeTaxParameters body → 200
GET
/taxes/employee/definitions
Get employee tax parameter definitions
getEmployeeTaxParameterDefinitions 2 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Employee (6 properties), CreateEmployeeRequest (5 properties), EmployeeTaxParameters (3 properties), OnboardLink (2 properties). Each schema is shown below with its type and property counts.

OnboardLink
object
2 properties
CreateEmployeeRequest
object
5 properties 3 required
Employee
object
6 properties
EmployeeTaxParameters
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeal-hq-employees-api-openapi.yml Raw ↑

Other APIs Zeal publishes across the network.

Zeal Companies API
Zeal Contractor Payments API
Zeal Contractors API
Zeal Employee Check API
Zeal Funding API
Zeal Onboarding API
Zeal Pay Schedules API
Zeal Reports API
Zeal Tax API