View journeys
View journeys
Retrieve a paginated list of journeys for an app, with cursor-based pagination and a lightweight summary representation of each journey.
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 audiencekind. 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
cursoron the first request. - Set
limitto control page size. The default is50and the maximum is50. - When more results exist, the response includes
has_more: trueand anext_cursortoken. Pass that token as thecursorparameter on the next request.cursoris opaque: send a priornext_cursorunchanged. Do not construct it. next_cursoris 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
Your App API key with prefix Key. See Keys & IDs.
Path Parameters
Your OneSignal App ID in UUID v4 format. See Keys & IDs.
Query Parameters
Opaque pagination token from a previous response's next_cursor. Omit for the first page.
Maximum journeys to return per page. Minimum 1, maximum 50.
Required range:
1 <= x <= 50