Skip to main content

Quickstart

1. Creating an API Access Token

Navigate to https://wb.workist.com/customer/integrations/api-integrations in the Workbench and create your own token under "API Integrations".

2. Sending Your First Request

  1. Open the Swagger UI: https://api.workist.com/v1/swagger/
  2. Click "Authorize" and paste your token from step 1
  3. Test the API with GET /orders/

3. Authentication

The Workist API uses Bearer token authentication.

Authorization: Bearer <your token>

4. Request Flow

  1. Upload an order, e.g. via POST /orders or through the Workbench
  2. Wait for the AI to process the document
  3. Retrieve all orders ready for import:
    GET /orders?imported=False&finished=True
  4. For each order:
    • a) Process on your side (e.g. import into ERP system)
    • b) Mark as imported with PUT /orders/{id}/mark_imported/

Master Data API

For transferring master data via API, see Using the Master Data API.