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

Positions represent open job requisitions within your company that are looking to be filled.

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

Tagged areas include Positions. 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 3 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 3 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 Positions 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.

Positions 2

Positions represent open job requisitions within your company that are looking to be filled.

GET
/positions/{uuid}
Retrieve an existing Position
GetPosition 2 params → 200401403404422429
GET
/positions
List existing Positions
GetPositions 7 params → 200401403404422429

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are position (15 properties), location (7 properties). Each schema is shown below with its type and property counts.

custom_field
array
Need to embed customfields in request query params.
location
object
Need to embed location in request query params.
7 properties
position
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workstream-positions-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 Employees API
Workstream Imported Employee Infos API
Workstream Locations API
Workstream Team Members API