Skip to main content

Search journeys

POST 
/participants/:user_id/journeys/search

Search self-enrollable journeys with a specific criteria.

When the "isEnrolled" property is null or not included, all journeys, both enrolled and non-enrolled, will be returned.

If "isEnrolled" is set to true, the search result will include only the journeys that the participant is currently enrolled in. In this case, the 'latestJourneyId' can be higher than journeyId. This means that there is a newer version of the journey and can be upgraded by specifiying "journeyIdToUpgrade": "${latestJourneyId}" in the enrolment request payload. If it is same id (i.e same version) then leave 'journeyIdToUpgrade' to null.

Conversely, if "isEnrolled" is set to false, the search result will include only the non-enrolled journeys available for the participant, i.e., all journeys that can be enrolled by the participant.

By default, the search will return only self-enrolled journeys. To include non-self-enrolled (prescribed) journeys in the search results, set 'includePrescribed' to true in the query option.

Request​

Responses​

OK

Response Headers
    Access-Control-Allow-Headers
    Access-Control-Allow-Methods
    Access-Control-Allow-Origin
    Cache-Control
    Content-Type