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 Authorization API

The Workstream API uses OAuth 2.0 Bearer access tokens to authenticate requests. You can view and manage your access tokens in the [Workstream Dashboard](https://hr.workstream.us/#/company?currentPanel=integrations&integrationItem=accesstoken).To generate an access token, simply click on `Generate token`, give it a name, and select the permissions(i.e. Applicants, Employees, Positions) to attach to it. **The token expires in 7 days.**You can also manage your tokens through API, as shown in the next section.

Workstream Authorization API is one of 12 APIs that Workstream publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.0.2, at version 1.0.0.

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

3 operations 3 paths 1 schemas 3 POST

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 Authorization 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 3

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

Authorization 3

The Workstream API uses OAuth 2.0 Bearer access tokens to authenticate requests. You can view and manage your access tokens in the [Workstream Dashboard](https://hr.workstream.us/…

POST
/tokens
Create a new access token
CreateAnAccessToken 5 params → 200401
POST
/tokens/refresh_token
Refresh the access token
RefreshAnAccessToken 4 params → 200401
POST
/revoke
Revoke an existing access token
RevokeAnAccessToken 3 params → 200403

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is access_token (5 properties). Each schema is shown below with its type and property counts.

access_token
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workstream-authorization-api-openapi.yml Raw ↑

Other APIs Workstream publishes across the network.

Workstream Applicants API
Workstream Company Roles API
Workstream Company Users API
Workstream Custom Field API
Workstream Departments API
Workstream Employee Documents API
Workstream Employees API
Workstream Imported Employee Infos API
Workstream Locations API
Workstream Positions API
Workstream Team Members API