ITiterable
workflows

Get journeys (workflows)

Get a list of the journeys within your project.

get/api/journeys

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Query parameters

pageinteger

Page number (starting at 1).

pageSizeinteger

Number of results to return per page (defaults to 10, maximum of 50).

sortstring

Sort field with optional direction prefix. Use - for descending, + or no prefix for ascending. Examples: -createdAt, +name, id

statestring[]

Without this parameter, the endpoint returns all non-archived journeys. With state set to Archived, the endpoint only returns archived journeys.

Response

successful operation

nextPageUrlstring

The URL to the next page of journeys, if applicable.

previousPageUrlstring

The URL to the previous page of journeys, if applicable.

totalJourneysCountinteger required

The total count of journeys across all pages for the supplied query.

Changes

No recorded changes to this operation across all 4 revisions of this API.