Journey Docs

API Overview

Journey APIs for members, partners, administrators, internal services, and public access

Journey API Overview

The Journey API provides product APIs for members, partners, administrators, internal services, and public experiences. The Core Platform guides organize durable operational contracts across the protected route surfaces.

API Surfaces

Core Platform is a domain-oriented guide, not a separate public credential or hostname. Its endpoints use /partner/*, /admin/*, and /internal/* according to the caller and trust boundary.

Base URLs

EnvironmentURL
Productionhttps://api-prd.cf.journey.com/v1
Developmenthttps://api-dev.cf.journey.com/v1

HXP Threads and Actions use https://v3.hxp.journey.com, different authentication, and explicit response envelopes. The base URLs and response format below apply to the Journey API surfaces above, not HXP.

Response Format

Responses return the resource directly as a JSON object or array — no wrapper envelope.

Error Handling

Errors return standardized HTTP status codes with a consistent error body:

{
  "type": "BadRequestException",
  "timestamp": "2026-04-21T17:45:09.534Z",
  "code": null,
  "message": "Validation failed (uuid is expected)"
}

Rate Limiting

Existing documented API surfaces use a default limit of 100 requests per minute. Endpoint-specific bounds may also apply. Respect Retry-After when present and use stable idempotency keys for Core mutations.

Support

For API issues, post in #team-engineering on Slack.

On this page