v1
latestOpenAPI 3.1.02026-08-062951103.4 KBflow_sessions
Retrieve a flow session
get/flow_sessions/{id}
Path parameters
idstring required
Flow session ID to retrieve
Response
OK
Example response
{
"id": "sess_eoTR48bvoOCd7SxXAKRrPhj0",
"status": "saved",
"flow": {
"id": "flow_3Aree3otQWV2qXhFiehIIQpA",
"name": "Default"
},
"subscriber": {
"id": "subr_dRiytWmkVtSBt9mOpRaC0ca0",
"platform_id": "cus_Jax42BBWGOWuDp",
"name": "Jane Doe",
"email": "jane@example.com",
"status": "saved",
"properties": [
{
"property": {
"id": "prop_jrtpyZs1httwFFIl7V80cHwf",
"key": "number_of_contacts",
"name": "Number of contacts",
"type": "number",
"format": "number"
},
"formatted_value": "5,800"
}
]
},
"subscription": {
"id": "subn_dp79dRR5wIy1kGW4PCO41wit",
"platform_id": "sub_JE1trB8eUAnh0r",
"subscriber_id": "subr_GQmXBebvivMb5tHhassNV9kj",
"mrr": "399.95",
"status": "active",
"properties": [
{
"property": {
"id": "prop_S6A17y8S8wgKBBJbveQHpLW6",
"key": "is_professional",
"name": "Is professional",
"type": "boolean",
"format": "null"
},
"formatted_value": "True"
}
]
},
"offers_presented": [
{
"id": "offr_jIGqAAUKqWM2pptJTfRuei1t",
"name": "40% off",
"details": {
"interval": "month",
"interval_count": 3
}
}
],
"offer_groups_presented": [
{
"id": "ofgr_8t5SRZsHgeVI4u8aKXxs8tIQ",
"name": "Win-back bundle",
"offers": [
{
"id": "offr_jIGqAAUKqWM2pptJTfRuei1t",
"name": "40% off",
"details": {
"interval": "month",
"interval_count": 3
}
}
]
}
],
"offer_accepted": {
"id": "offr_jIGqAAUKqWM2pptJTfRuei1t",
"name": "40% off",
"details": {
"interval": "month",
"interval_count": 3
}
},
"answers": [
{
"question": {
"id": "ques_By8b753fR4egFkzaJ8wBGK70",
"text": "What is your primary reason for leaving?"
},
"value": {
"id": "qopt_Jv3WHts65H9Iwz6bNcuBSapF",
"text": "Too expensive"
},
"sentiment": "null"
}
],
"steps": [
{
"step": {
"id": "step_S3biU4JN09ie6p52eIk3SWF3",
"type": "question",
"title": "What is your primary reason for leaving?"
}
}
],
"cancel_reason": {
"text": "Too expensive",
"reason_code": "too_expensive"
},
"deflected_by": {
"type": "deflection",
"details": {
"deflection": {
"id": "defl_qvNg13Ydk3N9C5Pw5AgTSfFU",
"name": "Account snapshot",
"actions": [
{
"id": "act_VkdRnVeN13G8eyehniYVP9ty",
"code": "support_chat",
"type": "url",
"details": {
"url": "https://acme.com/?action=support_chat"
}
}
]
},
"action": {
"id": "act_VkdRnVeN13G8eyehniYVP9ty",
"code": "support_chat",
"type": "url",
"details": {
"url": "https://acme.com/?action=support_chat"
}
}
}
}
}