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

Team Members represent team members that are managed within your company.

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

Tagged areas include Team Members. 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 12 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 12 schemas 2 GET1 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 Team Members 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 — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Team Members 4

Team Members represent team members that are managed within your company.

GET
/team_members/{uuid}
Retrieve an existing Team Member
GetTeamMember 2 params → 200401403404422429
PUT
/team_members/{uuid}/status
Update an existing Team Member's status
UpdateTeamMemberStatus 1 param body → 200401403404422429
GET
/team_members
List existing Team Members
GetTeamMembers 8 params → 200401403404422429
POST
/team_members
Create a new Team Member resource
CreateTeamMember body → 201401403404422429

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are creation-2 (15 properties), base (8 properties), federal_tax-2 (7 properties), information-2 (7 properties). Each schema is shown below with its type and property counts.

state_tax-2
object
Need to embed statetax in request query params.
4 properties
custom_field
array
Need to embed customfields in request query params.
federal_tax-2
object
Need to embed federaltax in request query params.
7 properties
base
object
8 properties
creation-2
object
15 properties 10 required
location-3
object
Need to embed location in request query params
2 properties
state_tax
object
Need to embed statetax in request query params.
6 properties
job_title
object
Need to embed jobtitle in request query params
2 properties
information-2
object
Need to embed information in request query params.
7 properties
department-3
object
Need to embed department in request query params
2 properties
direct_deposit
object
5 properties
team_member

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workstream-team-members-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 Positions API