# Quickwork Embedded API

**Canonical:** https://apis.io/apis/quickwork/quickwork-embedded-api/  
**Provider:** Quickwork — https://apis.io/providers/quickwork/  
**Base URL:** https://automation.quickwork.co  
**Documentation:** https://docs.quickwork.co/reference

Quickwork Embedded API is published by [Quickwork](https://apis.io/providers/quickwork/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Embedded. The published artifact set on APIs.io includes an OpenAPI specification.

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

## Operations (28)

| Method | Path | Summary |
|---|---|---|
| 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 |
| GET | `/embedded/api/partner/embedded-journeys/search` | Search Embedded Journey |
| 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 |

## Machine-readable artifacts (2)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/quickwork/refs/heads/main/openapi/quickwork-embedded-api-openapi.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/quickwork/refs/heads/main/apis.yml

## Tags

Embedded

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/quickwork/quickwork-embedded-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/quickwork/.