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 Custom Field API

Custom field config for location, department, job posting and employee within your company.

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

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

This API exposes 4 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}.

4 operations 3 paths 1 schemas 1 GET1 POST2 PUT

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 Custom Field 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 4

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

Custom Field 4

Custom field config for location, department, job posting and employee within your company.

GET
/custom_fields
List existing Custom Fields
ListCustomFields 1 param → 200401403422429
POST
/custom_fields
Create Custom Field
CreateCustomField body → 200401403422429
PUT
/custom_fields/{id}
Update an existing Custom Field
UpdateCustomField 1 param body → 200401403422429
PUT
/entity_type/{entity_type}/entity_id/{entity_id}/custom_field_values
Create or update custom field value
CreateOrUpdateCustomFieldValues 2 params body → 200401403422429

Schemas 1

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

show-2
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workstream-custom-field-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 Departments API
Workstream Employee Documents API
Workstream Employees API
Workstream Imported Employee Infos API
Workstream Locations API
Workstream Positions API
Workstream Team Members API