Skip to main content
GET
View journeys
Beta. The Journeys API is in beta. Endpoints and response fields can still change.

Overview

Retrieve a list of Journeys for an app. Each journey is returned in a summary representation that includes identity, state, scheduling, and re-entry fields, plus the audience kind. Use this list to find a journey id. Then fetch View journey for the full audience, nodes, and the concurrency_key required to update it.

How to use this API

Authenticate with your App API Key. The authenticated key must have permission to view journeys.

Pagination

This endpoint uses forward-only, cursor-based pagination. Journeys are returned newest first.
  • Omit cursor on the first request.
  • Set limit to control page size. The default is 50 and the maximum is 50.
  • When more results exist, the response includes has_more: true and a next_cursor token. Pass that token as the cursor parameter on the next request. cursor is opaque: send a prior next_cursor unchanged. Do not construct it.
  • next_cursor is omitted once there are no more pages.

Response

Each journey in the list excludes description, nodes, early_exit, and concurrency_key, and includes only the kind of its audience. Use View journey to retrieve the full audience, node configuration, and concurrency_key.

Error responses

Coded errors use the shape { "errors": [{ "code", "title", "meta" }] }.

Headers

Authorization
string
default:Key YOUR_APP_API_KEY
required

Your App API key with prefix Key. See Keys & IDs.

Path Parameters

app_id
string
default:YOUR_APP_ID
required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

Query Parameters

cursor
string

Opaque pagination token from a previous response's next_cursor. Omit for the first page.

limit
integer
default:50

Maximum journeys to return per page. Minimum 1, maximum 50.

Required range: 1 <= x <= 50

Response

200

journeys
object[]

Journeys ordered by creation time, newest first.

has_more
boolean

true if more journeys exist beyond this page.

next_cursor
string

Cursor for the next page. Present only when has_more is true.