cURL
curl --request GET \
--url http://localhost:3001/api/admin/journeys/ \
--header 'Authorization: <api-key>'{
"journeys": [
{
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"updatedAt": 123,
"status": "NotStarted",
"definitionUpdatedAt": 123,
"createdAt": 123,
"canRunMultiple": true,
"draft": {
"nodes": [
{
"id": "<string>",
"data": {
"type": "JourneyUiNodeDefinitionProps",
"nodeTypeProps": {
"type": "EntryUiNode",
"variant": {
"type": "EntryNode",
"segment": "<string>",
"child": "<string>"
}
}
}
}
],
"edges": [
{
"source": "<string>",
"target": "<string>",
"data": {
"type": "JourneyUiDefinitionEdgeProps",
"disableMarker": true
}
}
]
},
"sendSettings": {
"schedule": {
"type": "Immediate"
},
"rateLimit": {
"enabled": true,
"messagesPerHour": 5000.5,
"messagesPerDay": 50000.5,
"burstLimit": 500.5
},
"subscription": {
"respectUnsubscribes": true,
"allowResubscribe": true,
"requireDoubleOptIn": true,
"subscriptionGroups": [
"<string>"
]
},
"quietHours": {
"enabled": true,
"startTime": "<string>",
"endTime": "<string>",
"days": [
3
],
"timezone": "<string>"
},
"advanced": {
"retries": {
"enabled": true,
"maxAttempts": 5.5,
"backoffMultiplier": 3
},
"tracking": {
"enabled": true,
"trackOpens": true,
"trackClicks": true,
"trackUnsubscribes": true
},
"personalization": {
"enabled": true,
"fallbackValues": {}
},
"priority": "Low"
}
},
"definition": {
"entryNode": {
"type": "EntryNode",
"segment": "<string>",
"child": "<string>"
},
"exitNode": {
"type": "ExitNode"
},
"nodes": [
{
"id": "<string>",
"type": "DelayNode",
"variant": {
"type": "Second",
"seconds": 123
},
"child": "<string>"
}
]
}
}
]
}API Reference
GET /api/admin/journeys/
Get all journeys.
GET
/
api
/
admin
/
journeys
/
cURL
curl --request GET \
--url http://localhost:3001/api/admin/journeys/ \
--header 'Authorization: <api-key>'{
"journeys": [
{
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"updatedAt": 123,
"status": "NotStarted",
"definitionUpdatedAt": 123,
"createdAt": 123,
"canRunMultiple": true,
"draft": {
"nodes": [
{
"id": "<string>",
"data": {
"type": "JourneyUiNodeDefinitionProps",
"nodeTypeProps": {
"type": "EntryUiNode",
"variant": {
"type": "EntryNode",
"segment": "<string>",
"child": "<string>"
}
}
}
}
],
"edges": [
{
"source": "<string>",
"target": "<string>",
"data": {
"type": "JourneyUiDefinitionEdgeProps",
"disableMarker": true
}
}
]
},
"sendSettings": {
"schedule": {
"type": "Immediate"
},
"rateLimit": {
"enabled": true,
"messagesPerHour": 5000.5,
"messagesPerDay": 50000.5,
"burstLimit": 500.5
},
"subscription": {
"respectUnsubscribes": true,
"allowResubscribe": true,
"requireDoubleOptIn": true,
"subscriptionGroups": [
"<string>"
]
},
"quietHours": {
"enabled": true,
"startTime": "<string>",
"endTime": "<string>",
"days": [
3
],
"timezone": "<string>"
},
"advanced": {
"retries": {
"enabled": true,
"maxAttempts": 5.5,
"backoffMultiplier": 3
},
"tracking": {
"enabled": true,
"trackOpens": true,
"trackClicks": true,
"trackUnsubscribes": true
},
"personalization": {
"enabled": true,
"fallbackValues": {}
},
"priority": "Low"
}
},
"definition": {
"entryNode": {
"type": "EntryNode",
"segment": "<string>",
"child": "<string>"
},
"exitNode": {
"type": "ExitNode"
},
"nodes": [
{
"id": "<string>",
"type": "DelayNode",
"variant": {
"type": "Second",
"seconds": 123
},
"child": "<string>"
}
]
}
}
]
}⌘I

