Skip to main content
POST
List Journeys

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.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access. For delegated user tokens, ticket fields are limited to the fields the user can read. Journey aggregates are omitted when they depend on hidden ticket fields. Journey filters and sorting require access to the referenced fields.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_id
string
required

The ID of the workspace to list journeys for.

Body

application/json
filterGroups
JourneyFilterGroup · object[]

AND within a group, OR across groups. search predicates are global.

sort
JourneySortOption · object[]
pageSize
integer<int32> | null

Defaults to 100 when unset. Must be between 1 and 250; values outside that range produce a 400 InvalidArgument.

pageToken
string | null

Opaque cursor returned by a previous response. When provided, the same team_id / filter_groups / sort must be sent.

Response

200 - application/json

Success

data
JourneySummary · object[]
nextPageToken
string | null

Empty when there are no more pages.

totalCount
integer<int32>

Number of journeys matching the filters across all pages.

teamTotalCount
integer<int32>

Number of journeys for the workspace, ignoring filters.