Skip to Content
JourneyKit
Integration

API reference

The pages in this section are generated from the app's RPC router, so they always match what the dashboard itself calls. If you only need to send events and contact properties from your product, use the Ingest API instead, it is the stable, key-authenticated surface.

Calling a procedure

The base URL is https://journeykit.io/api/v1. Resources follow the usual REST shape, GET /workflows lists, POST /workflows creates, GET/PUT/DELETE /workflows/{id} read, replace and remove one, and actions that don't fit a verb are sub-resources (POST /workflows/{id}/duplicate, PATCH /workflows/{id}/status). GET inputs go in the query string (?from=2026-01-01&limit=50); everything else takes a JSON body. Responses are JSON.

Authentication

Every endpoint takes a secret workspace API key as a bearer token:

Authorization: Bearer jk_live_…

Create one under Settings → API keys (the full key is shown once). Every request is scoped to the workspace the key belongs to, there is no way to name another workspace. Public jk_pub_ keys are browser credentials for the Ingest API and are refused here.

To try an endpoint from these pages, paste the key into the Authorization field of the playground on any endpoint and press Send.

curl https://journeykit.io/api/v1/workflows \
  -H "Authorization: Bearer jk_live_…"

Errors

StatusMeaning
401Missing, unknown or revoked API key
403A public (jk_pub_) key was used
404The record you named does not belong to your workspace
400The body failed validation; the response lists each issue

On this page