Sign in

v1

latestOpenAPI 3.1.0Serval License2026-07-26202952779.1 KB
Journey API

List Journeys

List lean journey rows for a team. Returns identity, requester, progress, and health check counts per journey; call GetJourney for tasks and workflow failures.

get/v2/teams/{team_id}/journeys

Path parameters

team_idstring required

The ID of the team to list journeys for.

Query parameters

filterGroups.predicates.requester.operator'SET_OPERATOR_UNSPECIFIED' | 'SET_OPERATOR_INCLUDES' | 'SET_OPERATOR_EXCLUDES'
filterGroups.predicates.requester.userIdsstring[]
filterGroups.predicates.requester.currentUserboolean
filterGroups.predicates.requester.noneboolean
filterGroups.predicates.workflow.workflowIdsstring[]
filterGroups.predicates.completion.operator'COMPARISON_OPERATOR_UNSPECIFIED' | 'COMPARISON_OPERATOR_EQ' | 'COMPARISON_OPERATOR_NE' | 'COMPARISON_OPERATOR_GT' | 'COMPARISON_OPERATOR_GTE' | 'COMPARISON_OPERATOR_LT' | 'COMPARISON_OPERATOR_LTE'
filterGroups.predicates.completion.valueinteger
filterGroups.predicates.healthChecks.operator'SET_OPERATOR_UNSPECIFIED' | 'SET_OPERATOR_INCLUDES' | 'SET_OPERATOR_EXCLUDES'
filterGroups.predicates.healthChecks.statusesSvhelpModelsHealthCheckRollupStatus[]
filterGroups.predicates.dueDate.hasDueDateboolean

If true, only include items that have a due date set.

If true, only include items that have a due date set.

filterGroups.predicates.dueDate.isOverdueboolean

If true, only include items that are overdue (due date before today).

If true, only include items that are overdue (due date before today).

filterGroups.predicates.dueDate.dueBefore.yearinteger

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

filterGroups.predicates.dueDate.dueBefore.monthinteger

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

filterGroups.predicates.dueDate.dueBefore.dayinteger

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

filterGroups.predicates.customFields.filters.fieldIdstring
filterGroups.predicates.customFields.filters.fieldKeystring
filterGroups.predicates.customFields.filters.text.eqstring
filterGroups.predicates.customFields.filters.text.nestring
filterGroups.predicates.customFields.filters.text.containsstring
filterGroups.predicates.customFields.filters.text.startsWithstring
filterGroups.predicates.customFields.filters.text.endsWithstring
filterGroups.predicates.customFields.filters.text.doesNotContainstring
filterGroups.predicates.customFields.filters.text.likestring
filterGroups.predicates.customFields.filters.text.inList.valuesstring[]
filterGroups.predicates.customFields.filters.number.eqnumber double
filterGroups.predicates.customFields.filters.number.nenumber double
filterGroups.predicates.customFields.filters.number.gtnumber double
filterGroups.predicates.customFields.filters.number.gtenumber double
filterGroups.predicates.customFields.filters.number.ltnumber double
filterGroups.predicates.customFields.filters.number.ltenumber double
filterGroups.predicates.customFields.filters.boolValue.eqboolean
filterGroups.predicates.customFields.filters.boolValue.neboolean
integer
OR
string int64

Unix timestamp in seconds.

filterGroups.predicates.customFields.filters.enumValue.eqstring
filterGroups.predicates.customFields.filters.enumValue.nestring
filterGroups.predicates.customFields.filters.multiSelectValue.containsstring
filterGroups.predicates.customFields.filters.multiSelectValue.doesNotContainstring
filterGroups.predicates.customFields.sourceFilter.eqstring
filterGroups.predicates.customFields.sourceFilter.nestring
filterGroups.predicates.search.querystring
sort.field'JOURNEY_SORT_FIELD_UNSPECIFIED' | 'JOURNEY_SORT_FIELD_CREATED_AT' | 'JOURNEY_SORT_FIELD_REQUESTER' | 'JOURNEY_SORT_FIELD_NAME' | 'JOURNEY_SORT_FIELD_COMPLETION' | 'JOURNEY_SORT_FIELD_MANAGER' | 'JOURNEY_SORT_FIELD_HEALTH_CHECKS' | 'JOURNEY_SORT_FIELD_DUE_DATE' | 'JOURNEY_SORT_FIELD_CHATS'
sort.direction'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'
sort.customFieldIdstring

When field is UNSPECIFIED and custom_field_id is set, sort by this custom field.

When field is UNSPECIFIED and custom_field_id is set, sort by this custom field.

pageSizeinteger

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

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

pageTokenstring

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

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

Response

Success

nextPageTokenstring nullable

Empty when there are no more pages.

totalCountinteger

Number of journeys matching the filters across all pages.

teamTotalCountinteger

Number of journeys for the team, ignoring filters.