API Documentation

The Workist API connects your systems directly to Workist. Through it you upload documents, retrieve processed data, report import results back and transfer master data.

• Base URL: https://api.workist.com/v1 (equivalent: https://api.workist.com/api/v1)
• Swagger UI: https://api.workist.com/v1/swagger/, with all endpoints and schemas
• Authentication: API key in the header Authorization: Bearer <API key>

Sections

• Quickstart: create an API key and send your first request
• Document API: upload and retrieve documents and report the import result, for all document types
• Master Data API: transfer master data via API
• Webhooks: notify your system automatically on events

For development with AI assistants: AI Assistants — skill and Markdown versions of this documentation