Skip to main content
GET
Get Journey Options
Returns authoring choices from your account. Active sending lists and SMS audiences are included; creatives and offers include active and paused entries. Double opt-in choices include active journey configurations whose sending list can be resolved. Declares the journeys.read scope. Authenticate with X-Api-Key; see Authentication. A key with journeys.read can read these sending lists, audiences, creatives, offers, and double opt-in configurations through this endpoint.

Response Fields

array of objects
Integer id, string name, and nullable listType for each sending list. This endpoint currently returns null for listType.
array of objects
String id and name for each audience.
array of objects
Each entry contains id, name, message, characterCount, offers, status, listControlMode, and listControlIds. The id is a string; name is a string or null when the creative is unnamed.
array of objects
String id, name, status, listControlMode, and listControlIds.
array of strings
Cached contact custom-field names.
string
Current scan status; idle if no scan state is stored.
string or null
Last scan timestamp, or null before a scan.
array of objects
Integer id, name, integer sendingListId, and sendingListName.
Use Refresh Custom Fields to refresh the field names.