Skip to main content
GET
/
api
/
admin
/
journeys
cURL
curl --request GET \
  --url http://localhost/api/admin/journeys/ \
  --header 'Authorization: <api-key>'
{
  "journeys": [
    {
      "id": "<string>",
      "workspaceId": "<string>",
      "name": "<string>",
      "updatedAt": 123,
      "definitionUpdatedAt": 123,
      "createdAt": 123,
      "canRunMultiple": true,
      "draft": {
        "nodes": [
          {
            "id": "<string>",
            "data": {
              "nodeTypeProps": {
                "variant": {
                  "segment": "<string>",
                  "child": "<string>"
                }
              }
            }
          }
        ],
        "edges": [
          {
            "source": "<string>",
            "target": "<string>",
            "data": {
              "disableMarker": true
            }
          }
        ]
      },
      "sendSettings": {
        "schedule": {},
        "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": {}
          }
        }
      },
      "definition": {
        "entryNode": {
          "segment": "<string>",
          "child": "<string>"
        },
        "exitNode": {},
        "nodes": [
          {
            "id": "<string>",
            "variant": {
              "seconds": 123
            },
            "child": "<string>"
          }
        ]
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.tranthor.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Query Parameters

workspaceId
string
required

Response

200 - application/json

Default Response

journeys
object[]
required