Workist · OpenAPI Overlay 1.0.0

API Evangelist enhancements for the Workist Integrations & Developer API

4 actions 4 updates documentation extends openapi/workist-integrations-openapi-original.yml
Derived by API Evangelist Built from the contracts Workist publishes. Workist did not publish this file.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelistx-integration-patterndescription

Targets 3

$.info
$.servers
$.components.securitySchemes.BearerAuthentication

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for the Workist Integrations & Developer API
  version: 1.0.0
extends: openapi/workist-integrations-openapi-original.yml
actions:
- target: $.info
  update:
    x-apievangelist:
      aid: workist:workist-integrations-developer-api
      enriched: '2026-07-21'
      artifacts:
        authentication: authentication/workist-authentication.yml
        conventions: conventions/workist-conventions.yml
        errors: errors/workist-problem-types.yml
        lifecycle: lifecycle/workist-lifecycle.yml
        data-model: data-model/workist-data-model.yml
- target: $.info
  update:
    x-integration-pattern: >-
      Pull-based - upload documents (POST), poll list endpoints with
      imported=False&finished=True, import into the ERP, then PUT
      /{resource}/{id}/mark_imported. No webhooks are published.
- target: $.servers
  update:
  - url: https://api.workist.com/api/v1
    description: Production (absolute host added; original spec declares relative /v1/ and /api/v1/)
- target: $.components.securitySchemes.BearerAuthentication
  update:
    description: >-
      Bearer token created in the Workist Workbench under Integrations >
      API Integrations (https://wb.workist.com/customer/integrations/api-integrations).

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • 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 overlay
curl "https://apis.io/api/v1/overlays/workist-integrations-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

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.

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