Workstream

Workstream is an all-in-one HR, hiring, and payroll platform built for hourly businesses, particularly multi-location restaurants, serving 46 of the top 50 restaurant brands including Taco Bell, Jimmy John's, and Culver's. The platform covers applicant tracking and sourcing, Voice AI screening, onboarding, team management, time and scheduling, compliance, and full-service payroll. Workstream publishes a public REST API (OAuth 2.0 access tokens scoped to positions, applicants, employees, locations, departments, and custom fields) documented at docs.workstream.us.

Workstream publishes 12 API contracts indexed on the APIs.io network, including Applicants API, Authorization API, Company Roles API, and 9 more. Tagged areas include Company, Human Resources, Hiring, Payroll, and Onboarding.

The Workstream catalog on APIs.io includes 1 Spectral governance ruleset.

Workstream’s developer surface includes authentication, documentation, API reference, getting-started guide, support, engineering blog, pricing, and 11 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

52.0/100 developing ▬ flat Agent 19/100 agent aware Front door AI 5/6 prominent Heartbeat 100/100 alive saas Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →

AccessPaid

1 published contract

Company Human Resources Hiring Payroll Onboarding Applicant Tracking Hourly Workforce Restaurant

What this lets a business do 1

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Human Capital Management

BC-300

ApplicantsEmployee DocumentsEmployeesImported Employee InfosTeam Members

GET /position_applications GET /employees/{uuid} GET /employees GET /employee/docs/{document_id}

Kin Score

Kin Score How this is scored →
scored 2026-11-06 · rubric v0.27.0

Composite quality — 52.0/100 · developing

Contract Quality 8.4 / 19

Developer Ergonomics 8.6 / 15

Access Clarity 10.5 / 15

Operational Transparency 2.6 / 10

Contract Governance 1.2 / 9

Discoverability 5.5 / 8

Regulatory Posture 4.4 / 15

Create-or-Update Ergonomics 2.2 / 10

Agent readiness — 19/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 0 / 10

Documented Reversibility 0 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 0 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 0 / 7

Typed Event Surface 0 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 0 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Employment & Payroll regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/workstream/"><img src="https://apis.io/badge/workstream/card.svg" alt="Workstream on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
Agentic Access Contract +10 pts — agentic_access artifact present (x-agentic-access), graded by author
Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
Stable Error Semantics +8 pts — OpenAPI $refs a shared error schema across 4xx/5xx responses (verified), else common[].type includes ErrorCatalog / ErrorCodes / DeclineCodes
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Rate-Limit Signaling +7 pts — OpenAPI responses document X-RateLimit-* / RateLimit headers (verified), else a rate_limits artifact or RateLimits link (documented)

11 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Contract Quality scores 44.8 — up to +13.8 composite points
Contract Governance scores 13.6 — up to +10.4 composite points
Operational Transparency scores 26.3 — up to +9.6 composite points

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/workstream/apis.yml: open an issue on github.com/api-evangelist/workstream to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
HCM and Payroll Marketplaces (ADP, Workday, UKG, Paylocity)	builds-on	34.5 (thin)	-	-

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 2

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

OpenAPI

measured — observed by APIs.io (published)

OAuth 2.0

measured — observed by APIs.io (declared)

APIs 12

Individual APIs this provider publishes, each with its own machine-readable definition.

Workstream Applicants API

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

Workstream Authorization API

The Workstream API uses OAuth 2.0 Bearer access tokens to authenticate requests. You can view and manage your access tokens in the [Workstream Dashboard](https://hr.workstream.u...

Workstream Company Roles API

Company Roles represent roles within your company.

Workstream Company Users API

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

Workstream Custom Field API

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

Workstream Departments API

Departments represent departments within your company.

Workstream Employee Documents API

Employee Documents represent documents that are associated with employees within your company.

Workstream Employees API

Employees represent applicants who have been accepted into a new position, or people who are already working for your company.

Workstream Imported Employee Infos API

Imported Employee Infos represent imported employee information that is associated with employees within your company.

Workstream Locations API

Locations represent store locations within your company.

Workstream Positions API

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

Workstream Team Members API

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

Scroll for all 12

Open Collections 12

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Workstream Public Applicants API

OPEN COLLECTION

Workstream Public Applicants Authorization API

OPEN COLLECTION

Workstream Public Applicants Company Roles API

OPEN COLLECTION

Workstream Public Applicants Company Users API

OPEN COLLECTION

Workstream Public Applicants Custom Field API

OPEN COLLECTION

Workstream Public Applicants Departments API

OPEN COLLECTION

Workstream Public Applicants Employee Documents API

OPEN COLLECTION

Workstream Public Applicants Employees API

OPEN COLLECTION

Workstream Public Applicants Imported Employee Infos API

OPEN COLLECTION

Workstream Public Applicants Locations API

OPEN COLLECTION

Workstream Public Applicants Positions API

OPEN COLLECTION

Workstream Public Applicants Team Members API

OPEN COLLECTION

Scroll for all 12

Workstream API pricing

Prices published by Workstream, read 2026-10-28 from www.workstream.us/pricing.

Plan	Price
Hiring - AI-Assisted Hiring	Get in touch > Includes: Applicant tracking system, VoiceAI screening, VideoAI screening, AI hiring automations, Text-to-appl
Essentials - HR & Team Management	Get in touch > Includes: Everything in Hiring, plus HR & Onboarding, Team Management, Chat, Surveys
All-in-one - Payroll & Compliance	Get in touch > Includes: Everything in Essentials, plus Payroll, AI-Assisted Payroll, Compliance
Premium - Benefits & Custom	Get in touch > Includes: Everything in All-in-one, plus Benefits and Customization
Time & Scheduling add-on	Get in touch > Includes: Scheduling, Time Tracking, Shift Swapping
ACA & Benefits add-on	Get in touch > Includes: Eligibility Tracking, Benefits Administration, Payroll deductions
Workstream Compliance add-on	Get in touch > Includes: Labor compliance monitoring, Built-in alerts, Compliance heat maps

Plan details, limits and sources →

Pricing Plans 1

Published pricing tiers and plan structures.

Workstream Plans Pricing

7 plans

PLANS

Service Levels 1

Uptime the provider promises or reports, as SLA4OAI. Read from its own pages; APIs.io runs no monitors.

Workstream

SLA

FinOps 1

Cost, billing, and metering signals for API financial operations.

Workstream Finops

FINOPS

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

Workstream API Rules

76 rules · 58 errors 11 warnings 7 info

SPECTRAL

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Workstream Authentication

http/oauth2 · 2 schemes

SECURITY

Workstream Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Workstream Scopes

10 scopes · implicit

10 scopes

SCOPES

Resources

Get Started 3

Portal, sign-up, and the first successful call

DeveloperPortal

DeveloperPortal

GettingStarted

GettingStarted

Login

Documentation 2

Reference material describing how the API behaves

Documentation

Documentation

APIReference

APIReference

Access & Security 3

Authentication, authorization, and security posture

DomainSecurity

DomainSecurity

Authentication

Authentication

OAuthScopes

OAuthScopes

Operate 3

Status, limits, changes, and where to get help

Support

Support

HelpCenter

HelpCenter

StatusPage

StatusPage

Commercial 4

Pricing, plans, and the legal terms of use

Plans

Pricing

TermsOfService

PrivacyPolicy

Company 2

The organization behind the API

Website

Website

Blog

Blog

Other 1

Properties that don't map to a standard resource type

CapabilityMap

CapabilityMap

Source (apis.yml)

aid: workstream
name: Workstream
description: Workstream is an all-in-one HR, hiring, and payroll platform built for hourly businesses, particularly multi-location
  restaurants, serving 46 of the top 50 restaurant brands including Taco Bell, Jimmy John's, and Culver's. The platform covers
  applicant tracking and sourcing, Voice AI screening, onboarding, team management, time and scheduling, compliance, and full-service
  payroll. Workstream publishes a public REST API (OAuth 2.0 access tokens scoped to positions, applicants, employees, locations,
  departments, and custom fields) documented at docs.workstream.us.
url: https://raw.githubusercontent.com/api-evangelist/workstream/refs/heads/main/apis.yml
x-type: company
x-source: vc-portfolio
x-backed-by:
- bond-capital
- crv
x-tier: enriched
x-tier-reason: public-api
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: false
  label: Hosted service · you call their endpoint
  confidence: medium
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: paid
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Paid
  confidence: medium
  source:
  - plans
  - authentication
  - security
  generated: '2026-11-06'
  method: derived
specificationVersion: '0.23'
created: '2026-07-17'
modified: '2026-07-21'
x-docs-platform: redocly
x-docs-platform-confidence: high
x-docs-platform-checked: 2026-10-17
tags:
- Company
- Human Resources
- Hiring
- Payroll
- Onboarding
- Applicant Tracking
- Hourly Workforce
- Restaurant
tags_raw:
- Company
- Hr Tech
- Hiring
- Payroll
- Onboarding
- Applicant Tracking
- Hourly Workforce
- Restaurants
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/workstream.png
apis:
- aid: workstream:workstream-applicants-api
  name: Workstream Applicants API
  description: Applicants represent people who have applied for positions within your company.
  humanURL: https://docs.workstream.us/
  baseURL: https://public-api.workstream.us
  tags:
  - Applicants
  properties:
  - type: OpenAPI
    url: openapi/workstream-applicants-api-openapi.yml
  - type: Documentation
    url: https://docs.workstream.us/
  - type: APIReference
    url: https://docs.workstream.us/
- aid: workstream:workstream-authorization-api
  name: Workstream Authorization API
  description: 'The Workstream API uses OAuth 2.0 Bearer access tokens to authenticate requests. You can view and manage your
    access tokens in the [Workstream Dashboard](https://hr.workstream.us/#/company?currentPanel=integrations&integrationItem=accesstoken).


    To generate an access token, simply click on `Generate token`, give it a name, and select the permissions(i.e. Applicants,
    Employees, Positions) to attach to it. **The token expires in 7 days.**


    You can also manage your tokens through API, as shown in the next section.'
  humanURL: https://docs.workstream.us/
  baseURL: https://public-api.workstream.us
  tags:
  - Authorization
  properties:
  - type: OpenAPI
    url: openapi/workstream-authorization-api-openapi.yml
  - type: Documentation
    url: https://docs.workstream.us/
  - type: APIReference
    url: https://docs.workstream.us/
- aid: workstream:workstream-company-roles-api
  name: Workstream Company Roles API
  description: Company Roles represent roles within your company.
  humanURL: https://docs.workstream.us/
  baseURL: https://public-api.workstream.us
  tags:
  - Company Roles
  properties:
  - type: OpenAPI
    url: openapi/workstream-company-roles-api-openapi.yml
  - type: Documentation
    url: https://docs.workstream.us/
  - type: APIReference
    url: https://docs.workstream.us/
- aid: workstream:workstream-company-users-api
  name: Workstream Company Users API
  description: Company Users represent people who are system users within your company.
  humanURL: https://docs.workstream.us/
  baseURL: https://public-api.workstream.us
  tags:
  - Company Users
  properties:
  - type: OpenAPI
    url: openapi/workstream-company-users-api-openapi.yml
  - type: Documentation
    url: https://docs.workstream.us/
  - type: APIReference
    url: https://docs.workstream.us/
- aid: workstream:workstream-custom-field-api
  name: Workstream Custom Field API
  description: Custom field config for location, department, job posting and employee within your company.
  humanURL: https://docs.workstream.us/
  baseURL: https://public-api.workstream.us
  tags:
  - Custom Field
  properties:
  - type: OpenAPI
    url: openapi/workstream-custom-field-api-openapi.yml
  - type: Documentation
    url: https://docs.workstream.us/
  - type: APIReference
    url: https://docs.workstream.us/
- aid: workstream:workstream-departments-api
  name: Workstream Departments API
  description: Departments represent departments within your company.
  humanURL: https://docs.workstream.us/
  baseURL: https://public-api.workstream.us
  tags:
  - Departments
  properties:
  - type: OpenAPI
    url: openapi/workstream-departments-api-openapi.yml
  - type: Documentation
    url: https://docs.workstream.us/
  - type: APIReference
    url: https://docs.workstream.us/
- aid: workstream:workstream-employee-documents-api
  name: Workstream Employee Documents API
  description: Employee Documents represent documents that are associated with employees within your company.
  humanURL: https://docs.workstream.us/
  baseURL: https://public-api.workstream.us
  tags:
  - Employee Documents
  properties:
  - type: OpenAPI
    url: openapi/workstream-employee-documents-api-openapi.yml
  - type: Documentation
    url: https://docs.workstream.us/
  - type: APIReference
    url: https://docs.workstream.us/
- aid: workstream:workstream-employees-api
  name: Workstream Employees API
  description: Employees represent applicants who have been accepted into a new position, or people who are already working
    for your company.
  humanURL: https://docs.workstream.us/
  baseURL: https://public-api.workstream.us
  tags:
  - Employees
  properties:
  - type: OpenAPI
    url: openapi/workstream-employees-api-openapi.yml
  - type: Documentation
    url: https://docs.workstream.us/
  - type: APIReference
    url: https://docs.workstream.us/
- aid: workstream:workstream-imported-employee-infos-api
  name: Workstream Imported Employee Infos API
  description: Imported Employee Infos represent imported employee information that is associated with employees within your
    company.
  humanURL: https://docs.workstream.us/
  baseURL: https://public-api.workstream.us
  tags:
  - Imported Employee Infos
  properties:
  - type: OpenAPI
    url: openapi/workstream-imported-employee-infos-api-openapi.yml
  - type: Documentation
    url: https://docs.workstream.us/
  - type: APIReference
    url: https://docs.workstream.us/
- aid: workstream:workstream-locations-api
  name: Workstream Locations API
  description: Locations represent store locations within your company.
  humanURL: https://docs.workstream.us/
  baseURL: https://public-api.workstream.us
  tags:
  - Location
  tags_raw:
  - Locations
  properties:
  - type: OpenAPI
    url: openapi/workstream-locations-api-openapi.yml
  - type: Documentation
    url: https://docs.workstream.us/
  - type: APIReference
    url: https://docs.workstream.us/
- aid: workstream:workstream-positions-api
  name: Workstream Positions API
  description: Positions represent open job requisitions within your company that are looking to be filled.
  humanURL: https://docs.workstream.us/
  baseURL: https://public-api.workstream.us
  tags:
  - Positions
  properties:
  - type: OpenAPI
    url: openapi/workstream-positions-api-openapi.yml
  - type: Documentation
    url: https://docs.workstream.us/
  - type: APIReference
    url: https://docs.workstream.us/
- aid: workstream:workstream-team-members-api
  name: Workstream Team Members API
  description: Team Members represent team members that are managed within your company.
  humanURL: https://docs.workstream.us/
  baseURL: https://public-api.workstream.us
  tags:
  - Team Members
  properties:
  - type: OpenAPI
    url: openapi/workstream-team-members-api-openapi.yml
  - type: Documentation
    url: https://docs.workstream.us/
  - type: APIReference
    url: https://docs.workstream.us/
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
- FN: APIs.json
  email: info@apis.io
common:
- type: Plans
  url: plans/workstream-plans-pricing.yml
- type: CapabilityMap
  url: capabilities/workstream-capability-edges.yml
  name: Workstream Business Capability Map
- type: DomainSecurity
  url: security/workstream-domain-security.yml
- type: Authentication
  url: authentication/workstream-authentication.yml
- type: OAuthScopes
  url: scopes/workstream-scopes.yml
- type: Website
  url: https://workstream.us
- type: Documentation
  url: https://docs.workstream.us/
- type: APIReference
  url: https://docs.workstream.us/
- type: DeveloperPortal
  url: https://docs.workstream.us/
- type: GettingStarted
  url: https://help.workstream.us/en/articles/12278786-set-up-workstream-apis
- type: Support
  url: https://help.workstream.us/en/
- type: HelpCenter
  url: https://help.workstream.us/en/
- type: Blog
  url: https://www.workstream.us/blog
- type: Pricing
  url: https://www.workstream.us/pricing
- type: Login
  url: https://hr.workstream.us/
- type: TermsOfService
  url: https://workstream.us/terms/
- type: PrivacyPolicy
  url: https://www.workstream.us/privacy
- type: StatusPage
  url: https://workstream-status.statuspage.io/
- type: Integrations
  url: https://www.workstream.us/product/integrations

Workstream API — frequently asked questions

Does Workstream have an API?

Yes. APIs.io lists 12 APIs from Workstream, including Workstream Applicants API, Workstream Authorization API and Workstream Company Roles API, and 9 more.

Is there an OpenAPI specification for the Workstream API?

Yes. APIs.io indexes 12 OpenAPI specifications for Workstream, each linked for download from this page.

How do I authenticate with the Workstream API?

Workstream uses bearer-token authentication (http/oauth2 · 2 schemes). The details are profiled on APIs.io as Workstream Authentication.

How much does the Workstream API cost?

Workstream publishes its prices; its Hiring - AI-Assisted Hiring plan is Get in touch > as of 2026-10-28. APIs.io lists 7 pricing plans for Workstream, with each plan's price, limits and inclusions under Pricing on this page.

Is the Workstream API ready for AI agents?

Workstream has a Kin Score of 52.0 out of 100 (developing) and an Agent Readiness score of 19.0 (agent-aware), scored by API Evangelist on 2026-11-06.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/workstream"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/workstream/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/workstream/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.