v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB

Journey Node

List Journey Nodes

Retrieve a list of journey nodes

get/journey_node

Query parameters

idstring

Journey node ID

journey_version_idstring

Journey version ID

organisation_idstring

Organisation ID

typestring

Node type

event_typestring

Event type for trigger nodes

extra_context_schemastring

Schema for additional context data

namestring

Node name

selectstring

Filtering Columns

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Response

OK

idstring uuid

Journey node ID

journey_version_idstring uuid

Journey version ID

organisation_idstring uuid nullable

Organisation ID

type'trigger' | 'form' | 'filter' | 'wait_for_event' | 'wait_until' | 'wait_for_time' | 'send_message' | 'if_else' | 'switch' | 'set_conversation_status' | 'move_conversation_to_inbox' | 'set_conversation_is_spam' | 'set_conversation_assignee' | 'update_contact_list_membership' | 'update_conversation_tag' | 'add_conversation_comment' | 'set_contact_value' | 'set_deal_value' | 'set_appointment_value' | 'update_marketing_subscription' | 'segment_filter' | 'http_request' public.journey_node_type nullable

Node type

event_type'contact_created' | 'contact_changed' | 'deal_created' | 'deal_changed' | 'appointment_created' | 'appointment_changed' | 'deal_won' | 'deal_lost' | 'appointment_confirmed' | 'appointment_cancelled' | 'message_inbound' | 'appointment_started' | 'appointment_ended' | 'appointment_approaching' | 'marketing_subscription_accepted' | 'date' | 'birthday' | 'message_action_click' | 'conversation_closed' | 'conversation_reopened' | 'http' | 'review_request_submitted' | 'review_submitted' | 'form_completed' | 'message_outbound' | 'message_sending_error' | 'custom_entity_created' | 'custom_entity_changed' public.journey_event_type nullable

Event type for trigger nodes

extra_context_schemaobject nullable

Schema for additional context data

namestring text nullable

Node name