Quickwork

Quickwork Embedded API

The Embedded API from Quickwork — 27 operation(s) for embedded.

GitHub OpenAPI

Operations 28

POST /embedded/api/partner/connection Create connection #
POST /embedded/api/user/embedded-journey/{embeddedJourneyInstanceId}/connection Create connection in Embedded Journey instance #
POST /embedded/api/partner/user/{uniqueUserId}/instance Create Embedded Journey instance #
POST /embedded/api/partner/users/{uniqueUserId}/generate-one-time-token Create short-lived user token #
POST /embedded/api/partner/users Create user #
GET /embedded/api/partner/users Get users #
DELETE /embedded/api/partner/connection/{connectionId}/user/{uniqueUserId} Delete connection #
POST /embedded/api/partner/execute-action Execute action #
GET /embedded/api/user/connections/app/{appAlias} Get all connections #
GET /embedded/api/partner/embedded-journeys List Embedded Journeys #
GET /embedded/api/user/app/{appAlias} Get app configuration #
GET /embedded/api/partner/connection/configuration/{appAlias} Get connection details #
GET /embedded/api/user/embedded-journey/{embeddedJourneyInstanceId}/connection/app/{appAlias}/redirect-url Get connection redirect URL #
GET /embedded/api/partner/embedded-journey/{embeddedJourneyID} Get Embedded Journey #
GET /embedded/api/user/embedded-journey/{embeddedJourneyInstanceId} Get Embedded Journey instance #
POST /embedded/api/user/embedded-journey/{embeddedJourneyInstanceId}/extended-schema Get extended schema #
POST /embedded/api/user/embedded-journey/{embeddedJourneyInstanceId}/picklist Get picklist data #
POST /embedded/api/user/embedded-journey/{embeddedJourneyInstanceId}/connection/{connectionId}/app/{appAlias} Link connection #
POST /embedded/api/partner/user/{uniqueUserId}/instance/{embeddedJourneyInstanceId}/start Start Embedded Journey instance #
POST /embedded/api/partner/user/{uniqueUserId}/instance/{embeddedJourneyInstanceId}/stop Stop embedded journey instance #
POST /embedded/api/user/embedded-journey/{embeddedJourneyInstanceId}/connection/{connectionId}/test Test connection in Embedded Journey instance #
POST /embedded/api/partner/trigger Create trigger #
DELETE /embedded/api/partner/trigger/{triggerId} Delete trigger #
POST /embedded/api/partner/trigger/{triggerId}/start Start trigger #
POST /embedded/api/partner/trigger/{triggerId}/stop Stop trigger #
GET /embedded/api/partner/triggers List triggers #
PUT /embedded/api/user/embedded-journey/{embeddedJourneyInstanceId}/config-data Update config data #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/quickwork/openapi/quickwork-embedded-api-openapi.yml

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/quickwork/apis.yml

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/quickwork:quickwork-embedded-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

GitHub Google LinkedIn

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

OpenAPI Specification

quickwork-embedded-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Quickwork Embedded API
  version: 1.0.0
  description: 'Operations tagged Embedded across 24 of this provider''s published API definitions: quickwork-create-connection-api-openapi.yml, quickwork-create-connection-in-embedded-journey-instance-api-openapi.yml, quickwork-create-embedded-journey-instance-api-openapi.yml, quickwork-create-one-time-token-api-openapi.yml, quickwork-create-user-api-openapi.yml, quickwork-delete-connection-api-openapi.yml, quickwork-execute-action-api-openapi.yml, quickwork-get-all-connections-api-openapi.yml, quickwork-get-all-embedded-journeys-api-openapi.yml, quickwork-get-app-alias-api-openapi.yml, quickwork-get-connection-configuration-api-openapi.yml, quickwork-get-connection-redirect-url-api-openapi.yml, quickwork-get-embedded-journey-api-openapi.yml, quickwork-get-embedded-journey-instance-api-openapi.yml, quickwork-get-extended-schema-api-openapi.yml, quickwork-get-picklist-data-api-openapi.yml, quickwork-get-user-api-openapi.yml, quickwork-link-connection-api-openapi.yml, quickwork-search-embedded-journey-api-openapi.yml, quickwork-start-embedded-journey-instance-api-openapi.yml, quickwork-stop-embedded-journey-instance-api-openapi.yml, quickwork-test-connection-in-embedded-journey-instance-api-openapi.yml, quickwork-triggers-api-openapi.yml, quickwork-update-config-data-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{basePath}
  variables:
    basePath:
      default: automation.quickwork.co
      enum:
      - automation.quickwork.co
      - jp-automation.quickwork.co
      - otc-de-automation.quickwork.co
tags:


# --- truncated at 32 KB (188 KB total) ---
# Full source: https://artifacts.apis.io/quickwork/openapi/quickwork-embedded-api-openapi.yml