journeys

List journeys

Every journey with its status, step count and enrolment trigger.

status filters to active, paused, draft or archived. Only active journeys accept enrolments.

Optional business_id (UUID) filters to one business. A business-restricted key may name only a business it holds; another business answers 403 forbidden, and a malformed UUID answers 400 validation_failed. Without the filter, an organization-wide key lists every journey in its organization (the 100 most recently updated).

enrolment_trigger names the automatic entry rule when one is set; null means contacts enter only by explicit enrolment.

get/api/v1/journeys

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/journeys
  • Auth: HTTP bearer

Query parameters

statusstring

Filter by status.

business_idstring

Filter by business_id.

Response

Success

okboolean required

Example response

{
  "ok": true,
  "journeys": [
    {
      "id": "6c3829fd-a82a-404c-821c-4aabc430fb70",
      "business_id": "8070c984-41f6-4bfa-900b-1ce8750ad439",
      "name": "New patient onboarding",
      "status": "active",
      "step_count": 4,
      "created_at": "2026-07-01T09:00:00.000Z",
      "updated_at": "2026-08-01T10:00:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.