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

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.0.2, 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.0.2
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.

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