Get List Of Journeys
- 27 Jun 2025
- 9 Minutes to read
- Print
- DarkLight
Get List Of Journeys
- Updated on 27 Jun 2025
- 9 Minutes to read
- Print
- DarkLight
Article summary
The API endpoint `/messaging/client/journeys` retrieves a list of experiences from the CX Builder. It requires an API key and a client ID, with optional parameters for pagination, sorting, and filtering. Users can specify the starting offset, maximum item limit (up to 100), sort order (ascending or descending), and whether to exclude deleted journeys. The response includes detailed information about each journey, such as unique identifiers, creation and update timestamps, user emails, and associated labels. Additionally, it outlines various components of the journey, including message types, actions, and branding elements. The API also handles potential errors, such as invalid requests or unauthorized access, providing relevant status codes and messages. This functionality is essential for managing customer experiences effectively within the messaging framework.
Did you find this summary helpful?
Thank you for your feedback
Get
/messaging/client/{client_id}/journeys
This API returns a list of experiences from CX Builder
Header parameters
xx-relay-api-key
stringRequired
Contains the API key needed.
Path parameters
client_id
stringRequired
Client ID
Minimum1
Query parameters
offset
string
Identifies the starting offset of the list to be returned. If this property is not provided, it defaults to 0. There is no upper limit.
limit
integer
Identifies the maximum number of items returned.
Maximum100
order_direction
string
Sort order:
ASC- Ascending, from A to ZDESC- Descending, from Z to A
Valid values[ "ASC", "DESC" ]
exclude_deleted
boolean
Optional- Exclude the deleted journeys. If this property is not provided, it defaults to false. Valid Values > - true - Exclude deleted journeys from result set - false - Include deleted journeys
Valid values[ true, false ]
order_by
string
Sort order:
nameupdated at(default)created_atcreated_by_nameupdated_by_nameproduct_group_namecampaign
Valid values[ "name", "updated at (default)", "created_at", "created_by_name", "updated_by_name", "product_group_name", "campaign" ]
filter_by
string
Filters the list of Journey triggers returned. The filter works by only returning triggers that contain at least one of the labels specified in the filter_by parameters >
- More than one filter label can be specified by separating them with the pipe symbol (|). e.g. filter_by=facility|programs
- If a trigger does not contain any labels, it and all of its related components will be excluded from the returned list
- If all triggers are excluded from the Journey, then the Journey itself will be excluded
Responses
200
OK
object
id
string
Uniquely identifies a Journey.
Max length100
Example12345678-90ab-cdef-1234-567890abcdef
deleted
boolean
Has this journey been archived?
Valid values[ true, false ]
Max length100
Examplefalse
live_version
number
Content Version.
Max length100
Example1.0
draft_version
number
Content Version.
Max length100
Example1.0
created_at
string
ISO Timestamp
Max length100
Example2025-06-11T18:50:29.371Z
updated_at
string
ISO Timestamp
Max length100
Example2025-06-11T18:50:29.371Z
created_by_name
string
Email of user who { created, most recently updated } this journey
Max length100
Example[email protected]
updated_by_name
string
Email of user who { created, most recently updated } this journey
Max length100
Example[email protected]
draft
object (journey_content)
bypass_csr_validation
boolean
Journey content
Exampletrue
name
string
Journey Name
Max length100
ExampleWelcome to OneLife Health
product_group_name
string
Product group name that customers see when they access your messages
Max length100
ExampleOneLife Health
product_group_internal_name
string
Product group name Relay Portal users see within the CX Builder
Max length100
ExampleOneLife Health Group
created_at
string
ISO Timestamp
Max length100
Example2025-06-11T18:50:29.371Z
updated_at
string
ISO Timestamp
Max length100
Example2025-06-11T18:50:29.371Z
language
string
In which language is this journey intended
Valid values[ "en", "es" ]
Max length2
Exampleen
labels
Array of string
string
List of labels attributed to the journey in CXB
Example[ "welcome", "onboarding" ]
input_parameters
object (inputParameters)
This property contains a collection of input properties for the Journey. Input parameters are defined when the Journey is created or updated. Each input property must be prefixed with input_.
input_account_active
string
Max length100
Exampletrue
input_account_funding_date
string
Max length100
Example12/01/2023
components
Array of object (journeycomponent)
object
#content#
OneOf
APITriggerComponent
object (APITriggerComponent)
type
string
Valid values[ "APITrigger" ]
name
string
Unique identifier for this component
Example12345678-90ab-cdef-1234-567890abcdef
family
string
Identifier for all message constructors connected to this trigger. Should equal the trigger component'92s name
Example12345678-90ab-cdef-1234-567890abcdef
step
string
Used to identify component'92s location relative to the message tree
Example1, 2, 3
to
string
Next component in message tree
Example12345678-90ab-cdef-1234-567890abcdef
nickname
string
Optional nickname for trigger component set in CXB
ExampleWelcome Message
labels
Array of string
string
List of labels attributed to the journey in CXB
Example[ "label1", "label2" ]
MessageSenderComponent
object (MessageSenderComponent)
type
string
Valid values[ "MessageSender" ]
name
string
Unique identifier for this component
Example12345678-90ab-cdef-1234-567890abcdef
nickname
string
Optional nickname for trigger component set in CXB
ExampleWelcome Message
step
string
Used to identify component'92s location relative to the message tree
Example1, 2, 3
to
string
Next component in message tree
Example4567878-90ab-cdef-1234-567890abcdef
message_type
string
Examplecontent
outcome_name
string
Name of outcome selected in CXB
ExampleFunding
outcome_id
string
ID of outcome selected in CXB
Example4
wire
object (Wire)
is_alternate_message
boolean
Does this contain alternate message text content?
actions
object (Action)
id
string
Unique identifier for this action element
Example12345678-90ab-cdef-1234-567890abcdef
type
string
Type of action
Examplehyperlink, call, email, two-way, consent_upgrade, contact_card, form, collapsible
description
string
Description of Action Type
ExampleHyperlink, Call, Email, Two Way Message, Consent Upgrade, Contact Card, Power-Up, Collapsible
label
string
Label that displays on action button in Feed
ExampleClick Here, Call Us
value
string
Associated value of action element
Examplewww.google.com, 610-555-1212
show
boolean
Determines whether to show action in message
primary
boolean
Determines if action is the primary action. Not available for collapsible and in-feed consent upgrade actions.
open_in_new_tab
boolean
Determines whether to open link in new tab
nonDepositPopUpEnabled
boolean
Determines whether to display non deposit pop-up when clicking link
openConsentTCs
boolean
For Consent Upgrade Action Only- Determines whether to display consent terms and conditions when user clicks consent upgrade action
alternate_text
string
Alternate text content viewed in the feed if not all input variables are defined
show_banner
boolean
Determines whether to show banner in feed
media_id
string
Media asset ID of attacked media asset
Example12345678-90ab-cdef-1234-567890abcdef
branding
string | null
Media asset ID of branding asset
Example12345678-90ab-cdef-1234-567890abcdef
text
string
Primary message text content in feed
is_shown
boolean
Determines whether to display message content on feed
product_group
string
Product group associated with the message
Exampledefault
sms
object (SMS)
disclaimer
string
SMS text disclaimer
ExampleText help or stop. Msg&DataRatesMayApply
is_alternate_message
boolean
alternate_text
string | null
Alternate body that is sent if body contains input variables not present in client config. Can be an empty string if no alternate text is configured.
body
string
Text content body not including disclaimer
ExampleThere has been an update to your account.
auth_link
string
Input parameter for auth link that brings customer to Relay Feed
Example@{auth-link-experience-on-feed}' blackout_settings: $ref:
text
string
Full text message including body, auth_link, and disclaimer
ExampleThere has been an update to your account. @{auth-link-experience-on-feed} Text help or stop. Msg&DataRatesMayApply
is_shown
boolean
Determines if SMS text content is shown
date_created
string (date-time)
date_modified
string (date-time)
experience_type_name
string
experience_type_id
string
message_expiration
object (MessageExpiration)
amount
integer | null
unit
string | null
type
string
client_message_tag
string
Client message tag set in CXB
Examplenew-message
fdic
string
Determines FDIC signage display setting
Examplefdic insured, non-deposit, null
message_level_branding
object (MessageLevelBranding)
branding_logo
string
S3 url to download branding image
brand_name
string
Brand name
hex_code
string
Branding color
Example#808080
branding_id
string
Branding ID
timestamp
string
Informal timestamp
ExampleTue Jun 17 2025
labels
Array of string
string
List of labels attributed to the journey in CXB
Example[ "label-1", "label-2" ]
WorkflowDelayerComponent
object (WorkflowDelayerComponent)
type
string
This component is a time delay
Valid values[ "WorkflowDelayer" ]
name
string
Unique identifier for this component
Example12345678-90ab-cdef-1234-567890abcdef
step
string
Used to identify component'92s location relative to the message tree
Example1, 2, 3
to
string
Next component in message tree
Example12345678-90ab-cdef-1234-567890abcdef
interval_value
integer
Interval value
Example1
interval_type
string
Determines interval type
ExampleDay, Hour, Minute
WorkflowEnderComponent
object (WorkflowEnderComponent)
type
string
Valid values[ "WorkflowEnder" ]
name
string
Unique identifier for this component
Example12345678-90ab-cdef-1234-567890abcdef
step
string
Used to identify component'92s location relative to the message tree
Example1, 2, 3
to
string
Next component in message tree
Example12345678-90ab-cdef-1234-567890abcdef
family
string
Identifier for all message constructors connected to this trigger. Should equal the trigger component'92s name
Example12345678-90ab-cdef-1234-567890abcdef
labels
Array of string
string
List of labels attributed to the journey in CXB
Example[ "label-1", "label-2" ]
live
object (journey_content)
bypass_csr_validation
boolean
Journey content
Exampletrue
name
string
Journey Name
Max length100
ExampleWelcome to OneLife Health
product_group_name
string
Product group name that customers see when they access your messages
Max length100
ExampleOneLife Health
product_group_internal_name
string
Product group name Relay Portal users see within the CX Builder
Max length100
ExampleOneLife Health Group
created_at
string
ISO Timestamp
Max length100
Example2025-06-11T18:50:29.371Z
updated_at
string
ISO Timestamp
Max length100
Example2025-06-11T18:50:29.371Z
language
string
In which language is this journey intended
Valid values[ "en", "es" ]
Max length2
Exampleen
labels
Array of string
string
List of labels attributed to the journey in CXB
Example[ "welcome", "onboarding" ]
input_parameters
object (inputParameters)
This property contains a collection of input properties for the Journey. Input parameters are defined when the Journey is created or updated. Each input property must be prefixed with input_.
input_account_active
string
Max length100
Exampletrue
input_account_funding_date
string
Max length100
Example12/01/2023
components
Array of object (journeycomponent)
object
#content#
OneOf
APITriggerComponent
object (APITriggerComponent)
type
string
Valid values[ "APITrigger" ]
name
string
Unique identifier for this component
Example12345678-90ab-cdef-1234-567890abcdef
family
string
Identifier for all message constructors connected to this trigger. Should equal the trigger component'92s name
Example12345678-90ab-cdef-1234-567890abcdef
step
string
Used to identify component'92s location relative to the message tree
Example1, 2, 3
to
string
Next component in message tree
Example12345678-90ab-cdef-1234-567890abcdef
nickname
string
Optional nickname for trigger component set in CXB
ExampleWelcome Message
labels
Array of string
string
List of labels attributed to the journey in CXB
Example[ "label1", "label2" ]
MessageSenderComponent
object (MessageSenderComponent)
type
string
Valid values[ "MessageSender" ]
name
string
Unique identifier for this component
Example12345678-90ab-cdef-1234-567890abcdef
nickname
string
Optional nickname for trigger component set in CXB
ExampleWelcome Message
step
string
Used to identify component'92s location relative to the message tree
Example1, 2, 3
to
string
Next component in message tree
Example4567878-90ab-cdef-1234-567890abcdef
message_type
string
Examplecontent
outcome_name
string
Name of outcome selected in CXB
ExampleFunding
outcome_id
string
ID of outcome selected in CXB
Example4
wire
object (Wire)
is_alternate_message
boolean
Does this contain alternate message text content?
actions
object (Action)
id
string
Unique identifier for this action element
Example12345678-90ab-cdef-1234-567890abcdef
type
string
Type of action
Examplehyperlink, call, email, two-way, consent_upgrade, contact_card, form, collapsible
description
string
Description of Action Type
ExampleHyperlink, Call, Email, Two Way Message, Consent Upgrade, Contact Card, Power-Up, Collapsible
label
string
Label that displays on action button in Feed
ExampleClick Here, Call Us
value
string
Associated value of action element
Examplewww.google.com, 610-555-1212
show
boolean
Determines whether to show action in message
primary
boolean
Determines if action is the primary action. Not available for collapsible and in-feed consent upgrade actions.
open_in_new_tab
boolean
Determines whether to open link in new tab
nonDepositPopUpEnabled
boolean
Determines whether to display non deposit pop-up when clicking link
openConsentTCs
boolean
For Consent Upgrade Action Only- Determines whether to display consent terms and conditions when user clicks consent upgrade action
alternate_text
string
Alternate text content viewed in the feed if not all input variables are defined
show_banner
boolean
Determines whether to show banner in feed
media_id
string
Media asset ID of attacked media asset
Example12345678-90ab-cdef-1234-567890abcdef
branding
string | null
Media asset ID of branding asset
Example12345678-90ab-cdef-1234-567890abcdef
text
string
Primary message text content in feed
is_shown
boolean
Determines whether to display message content on feed
product_group
string
Product group associated with the message
Exampledefault
sms
object (SMS)
disclaimer
string
SMS text disclaimer
ExampleText help or stop. Msg&DataRatesMayApply
is_alternate_message
boolean
alternate_text
string | null
Alternate body that is sent if body contains input variables not present in client config. Can be an empty string if no alternate text is configured.
body
string
Text content body not including disclaimer
ExampleThere has been an update to your account.
auth_link
string
Input parameter for auth link that brings customer to Relay Feed
Example@{auth-link-experience-on-feed}' blackout_settings: $ref:
text
string
Full text message including body, auth_link, and disclaimer
ExampleThere has been an update to your account. @{auth-link-experience-on-feed} Text help or stop. Msg&DataRatesMayApply
is_shown
boolean
Determines if SMS text content is shown
date_created
string (date-time)
date_modified
string (date-time)
experience_type_name
string
experience_type_id
string
message_expiration
object (MessageExpiration)
amount
integer | null
unit
string | null
type
string
client_message_tag
string
Client message tag set in CXB
Examplenew-message
fdic
string
Determines FDIC signage display setting
Examplefdic insured, non-deposit, null
message_level_branding
object (MessageLevelBranding)
branding_logo
string
S3 url to download branding image
brand_name
string
Brand name
hex_code
string
Branding color
Example#808080
branding_id
string
Branding ID
timestamp
string
Informal timestamp
ExampleTue Jun 17 2025
labels
Array of string
string
List of labels attributed to the journey in CXB
Example[ "label-1", "label-2" ]
WorkflowDelayerComponent
object (WorkflowDelayerComponent)
type
string
This component is a time delay
Valid values[ "WorkflowDelayer" ]
name
string
Unique identifier for this component
Example12345678-90ab-cdef-1234-567890abcdef
step
string
Used to identify component'92s location relative to the message tree
Example1, 2, 3
to
string
Next component in message tree
Example12345678-90ab-cdef-1234-567890abcdef
interval_value
integer
Interval value
Example1
interval_type
string
Determines interval type
ExampleDay, Hour, Minute
WorkflowEnderComponent
object (WorkflowEnderComponent)
type
string
Valid values[ "WorkflowEnder" ]
name
string
Unique identifier for this component
Example12345678-90ab-cdef-1234-567890abcdef
step
string
Used to identify component'92s location relative to the message tree
Example1, 2, 3
to
string
Next component in message tree
Example12345678-90ab-cdef-1234-567890abcdef
family
string
Identifier for all message constructors connected to this trigger. Should equal the trigger component'92s name
Example12345678-90ab-cdef-1234-567890abcdef
labels
Array of string
string
List of labels attributed to the journey in CXB
Example[ "label-1", "label-2" ]
400
Invalid request
401
Unauthorized
404
Not Found - The requested resource was not found. Please verify the route parameter.
409
Conflict - Indicates the request could not be processed. A common reason is when attempting to create a new Journey object, but the ID already exists in the system.
500
An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request.}
Was this article helpful?