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 Company Users API

Company Users represent people who are system users within your company.

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

Tagged areas include Company Users. 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 4 schemas. 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 4 schemas 1 GET2 POST1 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 Company Users 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, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Company Users 4

Company Users represent people who are system users within your company.

GET
/company_users
List existing Company Users
GetCompanyUsers 5 params → 200401403404422429
POST
/company_users
Create a new Company User with User info
CreateCompanyStaff body → 201401403404422429
PUT
/company_users/{uuid}
Update an existing Company User's Company Role & permissions
updateCompanyStaff 1 param body → 200401403404422429
POST
/company_users/{uuid}/disable
Disable an active Company User
disableCompanyStaff 1 param → 200401403404422429

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are company_user (9 properties), company_role (5 properties), creation (5 properties), permission_config (2 properties). Each schema is shown below with its type and property counts.

company_user
object
9 properties
creation
object
5 properties 3 required
permission_config
object
Location & Department Permission configuration.
2 properties
company_role
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workstream-company-users-api-openapi.yml Raw ↑

Other APIs Workstream publishes across the network.

Workstream Applicants API
Workstream Authorization API
Workstream Company Roles 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