Journey API
List Journeys
List lean journey rows for a workspace, optionally filtered and sorted. Returns identity, requester, progress, and health check counts per journey; call GetJourney for tasks and workflow failures.
POST
/
v2
/
teams
/
{team_id}
/
journeys
/
search
List Journeys
curl --request POST \
--url https://public.api.serval.com/v2/teams/{team_id}/journeys/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filterGroups": [
{
"predicates": [
{
"chatCount": {
"value": 123
}
}
]
}
],
"sort": [
{
"customFieldId": "<string>"
}
],
"pageSize": 123,
"pageToken": "<string>"
}
'import requests
url = "https://public.api.serval.com/v2/teams/{team_id}/journeys/search"
payload = {
"filterGroups": [{ "predicates": [{ "chatCount": { "value": 123 } }] }],
"sort": [{ "customFieldId": "<string>" }],
"pageSize": 123,
"pageToken": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filterGroups: [{predicates: [{chatCount: {value: 123}}]}],
sort: [{customFieldId: '<string>'}],
pageSize: 123,
pageToken: '<string>'
})
};
fetch('https://public.api.serval.com/v2/teams/{team_id}/journeys/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public.api.serval.com/v2/teams/{team_id}/journeys/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filterGroups' => [
[
'predicates' => [
[
'chatCount' => [
'value' => 123
]
]
]
]
],
'sort' => [
[
'customFieldId' => '<string>'
]
],
'pageSize' => 123,
'pageToken' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public.api.serval.com/v2/teams/{team_id}/journeys/search"
payload := strings.NewReader("{\n \"filterGroups\": [\n {\n \"predicates\": [\n {\n \"chatCount\": {\n \"value\": 123\n }\n }\n ]\n }\n ],\n \"sort\": [\n {\n \"customFieldId\": \"<string>\"\n }\n ],\n \"pageSize\": 123,\n \"pageToken\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/teams/{team_id}/journeys/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filterGroups\": [\n {\n \"predicates\": [\n {\n \"chatCount\": {\n \"value\": 123\n }\n }\n ]\n }\n ],\n \"sort\": [\n {\n \"customFieldId\": \"<string>\"\n }\n ],\n \"pageSize\": 123,\n \"pageToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/teams/{team_id}/journeys/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filterGroups\": [\n {\n \"predicates\": [\n {\n \"chatCount\": {\n \"value\": 123\n }\n }\n ]\n }\n ],\n \"sort\": [\n {\n \"customFieldId\": \"<string>\"\n }\n ],\n \"pageSize\": 123,\n \"pageToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"teamId": "<string>",
"friendlyIdentifier": "<string>",
"name": "<string>",
"createdAt": "2025-01-15T01:30:15.000Z",
"requesterUserId": "<string>",
"requesterManagerUserId": "<string>",
"progressPercent": 123,
"archivedAt": "2025-01-15T01:30:15.000Z",
"dueDate": {
"year": 123,
"month": 123,
"day": 123
},
"metadata": {
"onboarding": {
"startDate": {
"year": 123,
"month": 123,
"day": 123
},
"welcomeMessage": "<string>"
},
"welcomeTitle": "<string>",
"welcomeBody": "<string>"
},
"createdByWorkflow": {
"id": "<string>",
"name": "<string>"
},
"healthCheckCounts": {
"totalCount": 123,
"failingCount": 123,
"warningCount": 123,
"passingCount": 123,
"runningCount": 123,
"noDataCount": 123,
"canceledCount": 123
},
"workflowFailureCount": 123,
"customFields": [
{
"fieldId": "<string>",
"fieldKey": "<string>",
"fieldName": "<string>",
"dataType": "DATA_TYPE_UNSPECIFIED",
"value": 123
}
]
}
],
"nextPageToken": "<string>",
"totalCount": 123,
"teamTotalCount": 123
}Authentication and permissions
Token requirements: User-based token (OAuth) or Organization-scoped API key or Workspace-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
| Credential | Access requirements |
|---|---|
| Organization-scoped API key | tickets:read |
| Workspace-scoped API key | tickets:read |
| User-based token (OAuth) | Supported, subject to permissions |
Authorizations
Body
application/json
Response
200 - application/json
Success
Was this page helpful?
⌘I
List Journeys
curl --request POST \
--url https://public.api.serval.com/v2/teams/{team_id}/journeys/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filterGroups": [
{
"predicates": [
{
"chatCount": {
"value": 123
}
}
]
}
],
"sort": [
{
"customFieldId": "<string>"
}
],
"pageSize": 123,
"pageToken": "<string>"
}
'import requests
url = "https://public.api.serval.com/v2/teams/{team_id}/journeys/search"
payload = {
"filterGroups": [{ "predicates": [{ "chatCount": { "value": 123 } }] }],
"sort": [{ "customFieldId": "<string>" }],
"pageSize": 123,
"pageToken": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filterGroups: [{predicates: [{chatCount: {value: 123}}]}],
sort: [{customFieldId: '<string>'}],
pageSize: 123,
pageToken: '<string>'
})
};
fetch('https://public.api.serval.com/v2/teams/{team_id}/journeys/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public.api.serval.com/v2/teams/{team_id}/journeys/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filterGroups' => [
[
'predicates' => [
[
'chatCount' => [
'value' => 123
]
]
]
]
],
'sort' => [
[
'customFieldId' => '<string>'
]
],
'pageSize' => 123,
'pageToken' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public.api.serval.com/v2/teams/{team_id}/journeys/search"
payload := strings.NewReader("{\n \"filterGroups\": [\n {\n \"predicates\": [\n {\n \"chatCount\": {\n \"value\": 123\n }\n }\n ]\n }\n ],\n \"sort\": [\n {\n \"customFieldId\": \"<string>\"\n }\n ],\n \"pageSize\": 123,\n \"pageToken\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/teams/{team_id}/journeys/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filterGroups\": [\n {\n \"predicates\": [\n {\n \"chatCount\": {\n \"value\": 123\n }\n }\n ]\n }\n ],\n \"sort\": [\n {\n \"customFieldId\": \"<string>\"\n }\n ],\n \"pageSize\": 123,\n \"pageToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/teams/{team_id}/journeys/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filterGroups\": [\n {\n \"predicates\": [\n {\n \"chatCount\": {\n \"value\": 123\n }\n }\n ]\n }\n ],\n \"sort\": [\n {\n \"customFieldId\": \"<string>\"\n }\n ],\n \"pageSize\": 123,\n \"pageToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"teamId": "<string>",
"friendlyIdentifier": "<string>",
"name": "<string>",
"createdAt": "2025-01-15T01:30:15.000Z",
"requesterUserId": "<string>",
"requesterManagerUserId": "<string>",
"progressPercent": 123,
"archivedAt": "2025-01-15T01:30:15.000Z",
"dueDate": {
"year": 123,
"month": 123,
"day": 123
},
"metadata": {
"onboarding": {
"startDate": {
"year": 123,
"month": 123,
"day": 123
},
"welcomeMessage": "<string>"
},
"welcomeTitle": "<string>",
"welcomeBody": "<string>"
},
"createdByWorkflow": {
"id": "<string>",
"name": "<string>"
},
"healthCheckCounts": {
"totalCount": 123,
"failingCount": 123,
"warningCount": 123,
"passingCount": 123,
"runningCount": 123,
"noDataCount": 123,
"canceledCount": 123
},
"workflowFailureCount": 123,
"customFields": [
{
"fieldId": "<string>",
"fieldKey": "<string>",
"fieldName": "<string>",
"dataType": "DATA_TYPE_UNSPECIFIED",
"value": 123
}
]
}
],
"nextPageToken": "<string>",
"totalCount": 123,
"teamTotalCount": 123
}
