Skip to main content
GET
/
api
/
admin
/
journeys
/
cURL
curl --request GET \
  --url http://localhost:3001/api/admin/journeys/ \
  --header 'Authorization: <api-key>'
import requests

url = "http://localhost:3001/api/admin/journeys/"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('http://localhost:3001/api/admin/journeys/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/admin/journeys/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "http://localhost:3001/api/admin/journeys/"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:3001/api/admin/journeys/")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3001/api/admin/journeys/")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "journeys": [
    {
      "id": "<string>",
      "workspaceId": "<string>",
      "name": "<string>",
      "updatedAt": 123,
      "status": "NotStarted",
      "createdAt": 123,
      "canRunMultiple": true,
      "definition": {
        "entryNode": {
          "type": "EntryNode",
          "segment": "<string>",
          "child": "<string>",
          "reEnter": true
        },
        "exitNode": {
          "type": "ExitNode"
        },
        "nodes": [
          {
            "id": "<string>",
            "type": "DelayNode",
            "variant": {
              "type": "Second",
              "seconds": 123
            },
            "child": "<string>"
          }
        ]
      },
      "draft": {
        "nodes": [
          {
            "id": "<string>",
            "data": {
              "type": "JourneyUiNodeDefinitionProps",
              "nodeTypeProps": {
                "type": "EntryUiNode",
                "variant": {
                  "type": "EntryNode",
                  "segment": "<string>",
                  "child": "<string>",
                  "reEnter": true
                }
              }
            }
          }
        ],
        "edges": [
          {
            "source": "<string>",
            "target": "<string>",
            "data": {
              "type": "JourneyUiDefinitionEdgeProps",
              "disableMarker": true
            }
          }
        ]
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Query Parameters

workspaceId
string
required
getPartial
boolean
ids
string[]
resourceType
Available options:
Declarative

Response

200 - application/json

Default Response

journeys
object[]
required