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

Applicants represent people who have applied for positions within your company.

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

Tagged areas include Applicants. 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 9 schemas. 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 9 schemas 3 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 Applicants 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 GET. Each is listed below with its method, path, parameters, and response codes.

Applicants 3

Applicants represent people who have applied for positions within your company.

GET
/position_applications/{uuid}
Retrieve an existing Applicant
GetApplicant 2 params → 200401403404422429
GET
/position_applications/{uuid}/forms
List Applicant's custom forms
GetApplicantForm 1 param → 200401403404422429
GET
/position_applications
List existing Applicants
GetApplicants 14 params → 200401403404422429

Schemas 9

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

tags
array
Need to embed tags in request query params
application_notes
array
Need to embed notes in request query params
location-2
object
Need to embed location in request query params
2 properties
position-2
object
Need to embed position in request query params
2 properties
applicant
object
22 properties
form
object
3 properties
pay_info
object
Need to embed payinfo in request query params
2 properties
candidate_info
array
Need to embed candidateinfo in request query params
department
object
Need to embed department in request query params
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workstream-applicants-api-openapi.yml Raw ↑

Other APIs Workstream publishes across the network.

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 Positions API
Workstream Team Members API