Skip to main content
GET
Get Journey schema
Retrieve the JSON Schema for the Journey document you plan to send.
Beta. The Journeys API is in beta. Endpoints and response fields can still change.

Access to schemas

The HTTP schema endpoint is public and app-independent. It requires no authentication or App ID. Retrieve the schema without a source Journey or available creation quota. Schema retrieval does not grant access to Journey data or writes. Other Journey endpoints still require authentication and app permissions.

Choose an operation

Send the required operation query parameter:
Omitting operation or sending an unsupported value returns 400. You can also send HEAD to the same path and query. A successful HEAD request returns headers without a response body.

Use the response

Read operation, document, and schema from the response. The schema object is a self-contained JSON Schema Draft 6 document with local $defs references. Validate the relevant document against schema, not the complete HTTP or MCP request. Routing IDs and concurrency_key are request metadata, not fields you must add to the schema document. The schema describes JSON structure. Write requests also enforce permissions, resource ownership, entitlements, and Journey rules.

Create and duplicate

Use Create Journey for writable fields and local node references. Use Duplicate Journey for copy behavior and overrides.

Journey updates

Use the update schema for the partial Journey document. Omitted top-level fields remain unchanged. Supplied nested objects and array members still need to satisfy their schema requirements. The schema also includes server-controlled fields from the Journey representation. Acceptance by the schema does not make every field writable. See Update Journey for applied fields, identity rules, and lifecycle restrictions.

Step updates

Use update_node to validate the complete node after applying a partial update. Do not validate a sparse node patch against this schema alone. For example, a patch that only changes duration_seconds does not need to repeat the existing node’s kind. The merged node still needs a valid kind. See Update Journey node for merge behavior and node restrictions.

FAQ

Does the response include instructions for calling MCP tools?

No. The response contains only operation, document, and schema. For MCP argument objects, schema retrieval, and concurrency requirements, see Manage Journeys with MCP.

Can I use a schema to check whether a write will succeed?

Not completely. A document can satisfy the schema and still fail permission, resource, entitlement, or Journey checks on the write request.

Query Parameters

operation
enum<string>
required

The authoring operation whose schema you need.

Available options:
create,
duplicate,
update,
update_node

Response

The schema and its applicability.

operation
enum<string>
required

The requested operation.

Available options:
create,
duplicate,
update,
update_node
document
enum<string>
required

The document that the schema describes. For update_node, merged_node is the complete node after applying the patch.

Available options:
body,
overrides,
patch,
merged_node
schema
object
required

A self-contained JSON Schema Draft 6 document with local $defs references.