How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Workstream Employees API

Employees represent applicants who have been accepted into a new position, or people who are already working for your company.

Workstream Employees API is one of 12 APIs that Workstream 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 2 operations across 2 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{tenant}.

2 operations 2 paths 21 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://public-api.workstream.us
Authentication
OAuth 2.0, HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Workstream Employees API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the implicit flow, exposing 10 scopes. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Employees 2

Employees represent applicants who have been accepted into a new position, or people who are already working for your company.

GET
/employees/{uuid}
Retrieve an existing Employee
GetEmployee 2 params → 200401403404422429
GET
/employees
List existing employees
GetEmployees 12 params → 200401403404422429

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are employee (25 properties), list_a (15 properties), i9_section_one (9 properties), federal_tax (9 properties). Each schema is shown below with its type and property counts.

emergency_contact
object
Need to embed emergencycontact in request query params.
4 properties
list_a
object
15 properties
work_location
object
Need to embed worklocation in request query params.
6 properties
department-2
object
Need to embed department in request query params
2 properties
list_b
object
7 properties
position-2
object
Need to embed position in request query params
2 properties
eligibility
object
Need to embed eligibility in request query params.
8 properties
eligibility_details
object
Need to embed eligibilitydetails in request query params.
2 properties
compensation
object
Need to embed compensation in request query params.
7 properties
location-2
object
Need to embed location in request query params
2 properties
i9_section_two
object
8 properties
address
object
Need to embed address in request query params.
5 properties
custom_forms
array
Need to embed customforms in request query params.
federal_tax
object
Need to embed federaltax in request query params.
9 properties
state_tax
object
Need to embed statetax in request query params.
6 properties
employee
object
25 properties
i9_section_one
object
9 properties
direct_deposit
object
5 properties
employment_details
object
Need to embed employmentdetails in request query params.
6 properties
information
object
Need to embed information in request query params.
7 properties
list_c
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workstream-employees-api-openapi.yml Raw ↑

Other APIs Workstream publishes across the network.

Workstream Applicants API
Workstream Authorization API
Workstream Company Roles API
Workstream Company Users API
Workstream Custom Field API
Workstream Departments API
Workstream Employee Documents API
Workstream Imported Employee Infos API
Workstream Locations API
Workstream Positions API
Workstream Team Members API
Where this information came from

This is an independent, third-party profile of Workstream Employees API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.