> ## Documentation Index
> Fetch the complete documentation index at: https://docs.serval.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /sections/api-reference/openapi-spec-v2.yaml get /v2/teams/{team_id}/journeys
openapi: 3.1.0
info:
  title: Serval Public API
  description: Serval Public API
  contact:
    name: Serval
    url: https://serval.com
    email: support@serval.com
  license:
    name: Serval License
    url: https://serval.com/license
  version: 2.0.0
servers:
  - url: https://public.api.serval.com
security:
  - BearerAuth: []
tags:
  - name: Access Policy API
  - name: Access Policy Approval Procedure API
  - name: Access Profile API
  - name: Access Relationship API
  - name: Access Request API
  - name: Agent Session API
  - name: App Instance API
  - name: App Resource API
  - name: App Resource Role API
  - name: Approval Delegation API
  - name: Approval Request API
  - name: Audit Log API
  - name: Change Blackout API
  - name: Change Model API
  - name: Custom Field API
  - name: Custom Service API
  - name: Entity API
  - name: Entity Field Mapping API
  - name: Entity Ingestion Config API
  - name: Entity Type API
  - name: Folder API
  - name: Group API
  - name: Guidance API
  - name: Help Agent API
  - name: Journey API
  - name: Knowledge API
  - name: Knowledge Base API
  - name: Report API
  - name: SLA API
  - name: Schedule API
  - name: Tag API
  - name: Team API
  - name: Team User API
  - name: Ticket API
  - name: Topic API
  - name: User API
  - name: User Relationship API
  - name: Workflow API
  - name: Workflow Approval Procedure API
  - name: Workflow Run API
paths:
  /v2/teams/{team_id}/journeys:
    get:
      tags:
        - Journey API
      summary: List Journeys
      description: >-
        List lean journey rows for a team. Returns identity, requester,
        progress, and health check counts per journey; call GetJourney for tasks
        and workflow failures.
      operationId: svrelay.publicv2.PublicAPIServiceV2.ListJourneys
      parameters:
        - name: team_id
          in: path
          required: true
          schema:
            type: string
            title: team_id
            description: The ID of the team to list journeys for.
        - name: filterGroups.predicates.requester.operator
          in: query
          schema:
            $ref: '#/components/schemas/svhelp.models.SetOperator'
            title: operator
        - name: filterGroups.predicates.requester.userIds
          in: query
          schema:
            type: array
            items:
              type: string
            title: user_ids
        - name: filterGroups.predicates.requester.currentUser
          in: query
          schema:
            type: boolean
            title: current_user
        - name: filterGroups.predicates.requester.none
          in: query
          schema:
            type: boolean
            title: none
        - name: filterGroups.predicates.workflow.workflowIds
          in: query
          schema:
            type: array
            items:
              type: string
            title: workflow_ids
        - name: filterGroups.predicates.completion.operator
          in: query
          schema:
            $ref: '#/components/schemas/svhelp.models.ComparisonOperator'
            title: operator
        - name: filterGroups.predicates.completion.value
          in: query
          schema:
            type: integer
            title: value
            format: int32
        - name: filterGroups.predicates.healthChecks.operator
          in: query
          schema:
            $ref: '#/components/schemas/svhelp.models.SetOperator'
            title: operator
        - name: filterGroups.predicates.healthChecks.statuses
          in: query
          schema:
            type: array
            items:
              $ref: '#/components/schemas/svhelp.models.HealthCheckRollupStatus'
            title: statuses
        - name: filterGroups.predicates.dueDate.hasDueDate
          in: query
          description: If true, only include items that have a due date set.
          schema:
            type: boolean
            title: has_due_date
            description: If true, only include items that have a due date set.
        - name: filterGroups.predicates.dueDate.isOverdue
          in: query
          description: >-
            If true, only include items that are overdue (due date before
            today).
          schema:
            type: boolean
            title: is_overdue
            description: >-
              If true, only include items that are overdue (due date before
              today).
        - name: filterGroups.predicates.dueDate.dueBefore.year
          in: query
          description: >-
            Year of the date. Must be from 1 to 9999, or 0 to specify a date
            without
             a year.
          schema:
            type: integer
            title: year
            format: int32
            description: >-
              Year of the date. Must be from 1 to 9999, or 0 to specify a date
              without
               a year.
        - name: filterGroups.predicates.dueDate.dueBefore.month
          in: query
          description: >-
            Month of a year. Must be from 1 to 12, or 0 to specify a year
            without a
             month and day.
          schema:
            type: integer
            title: month
            format: int32
            description: >-
              Month of a year. Must be from 1 to 12, or 0 to specify a year
              without a
               month and day.
        - name: filterGroups.predicates.dueDate.dueBefore.day
          in: query
          description: >-
            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.
          schema:
            type: integer
            title: day
            format: int32
            description: >-
              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.
        - name: filterGroups.predicates.customFields.filters.fieldId
          in: query
          schema:
            type: string
            title: field_id
        - name: filterGroups.predicates.customFields.filters.fieldKey
          in: query
          schema:
            type: string
            title: field_key
        - name: filterGroups.predicates.customFields.filters.text.eq
          in: query
          schema:
            type: string
            title: eq
        - name: filterGroups.predicates.customFields.filters.text.ne
          in: query
          schema:
            type: string
            title: ne
        - name: filterGroups.predicates.customFields.filters.text.contains
          in: query
          schema:
            type: string
            title: contains
        - name: filterGroups.predicates.customFields.filters.text.startsWith
          in: query
          schema:
            type: string
            title: starts_with
        - name: filterGroups.predicates.customFields.filters.text.endsWith
          in: query
          schema:
            type: string
            title: ends_with
        - name: filterGroups.predicates.customFields.filters.text.doesNotContain
          in: query
          schema:
            type: string
            title: does_not_contain
        - name: filterGroups.predicates.customFields.filters.text.like
          in: query
          schema:
            type: string
            title: like
        - name: filterGroups.predicates.customFields.filters.text.inList.values
          in: query
          schema:
            type: array
            items:
              type: string
            title: values
        - name: filterGroups.predicates.customFields.filters.number.eq
          in: query
          schema:
            type: number
            title: eq
            format: double
        - name: filterGroups.predicates.customFields.filters.number.ne
          in: query
          schema:
            type: number
            title: ne
            format: double
        - name: filterGroups.predicates.customFields.filters.number.gt
          in: query
          schema:
            type: number
            title: gt
            format: double
        - name: filterGroups.predicates.customFields.filters.number.gte
          in: query
          schema:
            type: number
            title: gte
            format: double
        - name: filterGroups.predicates.customFields.filters.number.lt
          in: query
          schema:
            type: number
            title: lt
            format: double
        - name: filterGroups.predicates.customFields.filters.number.lte
          in: query
          schema:
            type: number
            title: lte
            format: double
        - name: filterGroups.predicates.customFields.filters.boolValue.eq
          in: query
          schema:
            type: boolean
            title: eq
        - name: filterGroups.predicates.customFields.filters.boolValue.ne
          in: query
          schema:
            type: boolean
            title: ne
        - name: filterGroups.predicates.customFields.filters.timestamp.eq.seconds
          in: query
          description: Unix timestamp in seconds.
          schema:
            type:
              - integer
              - string
            title: seconds
            format: int64
            description: Unix timestamp in seconds.
        - name: filterGroups.predicates.customFields.filters.enumValue.eq
          in: query
          schema:
            type: string
            title: eq
        - name: filterGroups.predicates.customFields.filters.enumValue.ne
          in: query
          schema:
            type: string
            title: ne
        - name: >-
            filterGroups.predicates.customFields.filters.multiSelectValue.contains
          in: query
          schema:
            type: string
            title: contains
        - name: >-
            filterGroups.predicates.customFields.filters.multiSelectValue.doesNotContain
          in: query
          schema:
            type: string
            title: does_not_contain
        - name: filterGroups.predicates.customFields.sourceFilter.eq
          in: query
          schema:
            type: string
            title: eq
        - name: filterGroups.predicates.customFields.sourceFilter.ne
          in: query
          schema:
            type: string
            title: ne
        - name: filterGroups.predicates.search.query
          in: query
          schema:
            type: string
            title: query
        - name: sort.field
          in: query
          schema:
            $ref: '#/components/schemas/svhelp.models.JourneySortField'
            title: field
        - name: sort.direction
          in: query
          schema:
            $ref: '#/components/schemas/svhelp.models.SortDirection'
            title: direction
        - name: sort.customFieldId
          in: query
          description: >-
            When field is UNSPECIFIED and custom_field_id is set, sort by this
            custom field.
          schema:
            type: string
            title: custom_field_id
            description: >-
              When field is UNSPECIFIED and custom_field_id is set, sort by this
              custom field.
        - name: pageSize
          in: query
          description: |-
            Defaults to 100 when unset. Must be between 1 and 250; values
             outside that range produce a 400 InvalidArgument.
          schema:
            type: integer
            title: page_size
            format: int32
            description: |-
              Defaults to 100 when unset. Must be between 1 and 250; values
               outside that range produce a 400 InvalidArgument.
        - name: pageToken
          in: query
          description: |-
            Opaque cursor returned by a previous response. When provided, the
             same team_id / filter_groups / sort must be sent.
          schema:
            type: string
            title: page_token
            description: |-
              Opaque cursor returned by a previous response. When provided, the
               same team_id / filter_groups / sort must be sent.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/svhelp.publicapi.ListJourneysResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
      security:
        - BearerAuth: []
components:
  schemas:
    svhelp.models.SetOperator:
      type: string
      title: SetOperator
      enum:
        - SET_OPERATOR_UNSPECIFIED
        - SET_OPERATOR_INCLUDES
        - SET_OPERATOR_EXCLUDES
    svhelp.models.ComparisonOperator:
      type: string
      title: ComparisonOperator
      enum:
        - COMPARISON_OPERATOR_UNSPECIFIED
        - COMPARISON_OPERATOR_EQ
        - COMPARISON_OPERATOR_NE
        - COMPARISON_OPERATOR_GT
        - COMPARISON_OPERATOR_GTE
        - COMPARISON_OPERATOR_LT
        - COMPARISON_OPERATOR_LTE
    svhelp.models.HealthCheckRollupStatus:
      type: string
      title: HealthCheckRollupStatus
      enum:
        - HEALTH_CHECK_ROLLUP_STATUS_UNSPECIFIED
        - HEALTH_CHECK_ROLLUP_STATUS_PASSING
        - HEALTH_CHECK_ROLLUP_STATUS_WARNING
        - HEALTH_CHECK_ROLLUP_STATUS_FAILING
        - HEALTH_CHECK_ROLLUP_STATUS_NONE
    svhelp.models.JourneySortField:
      type: string
      title: JourneySortField
      enum:
        - 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
    svhelp.models.SortDirection:
      type: string
      title: SortDirection
      enum:
        - SORT_DIRECTION_UNSPECIFIED
        - SORT_DIRECTION_ASC
        - SORT_DIRECTION_DESC
    svhelp.publicapi.ListJourneysResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/svhelp.pubapimodels.JourneySummary'
          title: data
          x-stainless-terraform-configurability: optional
        nextPageToken:
          type: string
          title: next_page_token
          description: Empty when there are no more pages.
          nullable: true
          x-stainless-terraform-configurability: optional
        totalCount:
          type: integer
          title: total_count
          format: int32
          description: Number of journeys matching the filters across all pages.
          x-stainless-terraform-configurability: optional
        teamTotalCount:
          type: integer
          title: team_total_count
          format: int32
          description: Number of journeys for the team, ignoring filters.
          x-stainless-terraform-configurability: optional
      title: ListJourneysResponse
      additionalProperties: false
    connect.error:
      type: object
      properties:
        code:
          type: string
          examples:
            - not_found
          enum:
            - canceled
            - unknown
            - invalid_argument
            - deadline_exceeded
            - not_found
            - already_exists
            - permission_denied
            - resource_exhausted
            - failed_precondition
            - aborted
            - out_of_range
            - unimplemented
            - internal
            - unavailable
            - data_loss
            - unauthenticated
          description: >-
            The status code, which should be an enum value of
            [google.rpc.Code][google.rpc.Code].
          x-stainless-terraform-configurability: optional
        message:
          type: string
          description: >-
            A developer-facing error message, which should be in English. Any
            user-facing error message should be localized and sent in the
            [google.rpc.Status.details][google.rpc.Status.details] field, or
            localized by the client.
          x-stainless-terraform-configurability: optional
        detail:
          $ref: '#/components/schemas/google.protobuf.Any'
          x-stainless-terraform-configurability: optional
      title: Connect Error
      additionalProperties: true
      description: >-
        Error type returned by Connect:
        https://connectrpc.com/docs/go/errors/#http-representation
    svhelp.pubapimodels.JourneySummary:
      type: object
      properties:
        id:
          type: string
          title: id
          description: The ID of the journey ticket.
          readOnly: true
          x-stainless-terraform-configurability: computed
        teamId:
          type: string
          title: team_id
          description: The ID of the team that owns the journey.
          x-stainless-terraform-configurability: optional
        friendlyIdentifier:
          type: string
          title: friendly_identifier
          description: Friendly identifier such as "ACM-42".
          readOnly: true
          x-stainless-terraform-configurability: computed
        name:
          type: string
          title: name
          description: Journey name.
          x-stainless-terraform-configurability: optional
        createdAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: created_at
          description: Timestamp when the journey was created.
          readOnly: true
          x-stainless-terraform-configurability: computed
        requesterUserId:
          type: string
          title: requester_user_id
          description: The user the journey is for.
          nullable: true
          x-stainless-terraform-configurability: optional
        requesterManagerUserId:
          type: string
          title: requester_manager_user_id
          description: The requester's manager (from user relationships).
          nullable: true
          x-stainless-terraform-configurability: optional
        progressPercent:
          type: integer
          title: progress_percent
          format: int32
          description: Completion percent across the journey's tasks.
          x-stainless-terraform-configurability: optional
        archivedAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: archived_at
          description: When the journey was archived, if any.
          nullable: true
          x-stainless-terraform-configurability: optional
        dueDate:
          $ref: '#/components/schemas/google.type.Date'
          title: due_date
          description: Due date on the journey ticket (date only).
          nullable: true
          x-stainless-terraform-configurability: optional
        metadata:
          $ref: '#/components/schemas/svhelp.pubapimodels.JourneyMetadata'
          title: metadata
          description: Journey-specific metadata.
          nullable: true
          x-stainless-terraform-configurability: optional
        createdByWorkflow:
          $ref: '#/components/schemas/svhelp.pubapimodels.JourneyWorkflowInfo'
          title: created_by_workflow
          description: The workflow that created the journey, if any.
          nullable: true
          x-stainless-terraform-configurability: optional
        healthCheckCounts:
          $ref: '#/components/schemas/svhelp.pubapimodels.JourneyHealthCheckCounts'
          title: health_check_counts
          description: Aggregate counts of the journey's health checks.
          x-stainless-terraform-configurability: optional
        workflowFailureCount:
          type: integer
          title: workflow_failure_count
          format: int32
          description: >-
            Number of workflow failures GetJourney would return for this
            journey.
          x-stainless-terraform-configurability: optional
        customFields:
          type: array
          items:
            $ref: '#/components/schemas/svhelp.pubapimodels.CustomFieldValueSummary'
          title: custom_fields
          description: Custom fields explicitly set on the top-level journey ticket.
          x-stainless-terraform-configurability: optional
      title: JourneySummary
      additionalProperties: false
      description: |-
        A lean journey row returned by ListJourneys. Excludes tasks, health
         checks, and workflow failures; consumers call GetJourney for detail.
    google.protobuf.Any:
      type: object
      properties:
        type:
          type: string
          x-stainless-terraform-configurability: optional
        value:
          type: string
          format: binary
          x-stainless-terraform-configurability: optional
        debug:
          type: object
          additionalProperties: true
          x-stainless-terraform-configurability: optional
      additionalProperties: true
      description: >-
        Contains an arbitrary serialized message along with a @type that
        describes the type of the serialized message.
    google.protobuf.Timestamp:
      type: string
      format: date-time
      description: A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").
    google.type.Date:
      type: object
      properties:
        year:
          type: integer
          title: year
          format: int32
          description: >-
            Year of the date. Must be from 1 to 9999, or 0 to specify a date
            without
             a year.
          x-stainless-terraform-configurability: optional
        month:
          type: integer
          title: month
          format: int32
          description: >-
            Month of a year. Must be from 1 to 12, or 0 to specify a year
            without a
             month and day.
          x-stainless-terraform-configurability: optional
        day:
          type: integer
          title: day
          format: int32
          description: >-
            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.
          x-stainless-terraform-configurability: optional
      title: Date
      additionalProperties: false
      description: >-
        Represents a whole or partial calendar date, such as a birthday. The
        time of
         day and time zone are either specified elsewhere or are insignificant. The
         date is relative to the Gregorian Calendar. This can represent one of the
         following:

         * A full date, with non-zero year, month, and day values
         * A month and day value, with a zero year, such as an anniversary
         * A year on its own, with zero month and day values
         * A year and month value, with a zero day, such as a credit card expiration
         date

         Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
         `google.protobuf.Timestamp`.
    svhelp.pubapimodels.JourneyMetadata:
      type: object
      oneOf:
        - $ref: '#/components/schemas/svhelp.pubapimodels.JourneyMetadata.Onboarding'
      title: JourneyMetadata
      description: Metadata for a journey, shown at the top of the journey view.
    svhelp.pubapimodels.JourneyWorkflowInfo:
      type: object
      properties:
        id:
          type: string
          title: id
          x-stainless-terraform-configurability: optional
        name:
          type: string
          title: name
          x-stainless-terraform-configurability: optional
      title: JourneyWorkflowInfo
      additionalProperties: false
      description: Reference to a workflow.
    svhelp.pubapimodels.JourneyHealthCheckCounts:
      type: object
      properties:
        totalCount:
          type: integer
          title: total_count
          format: int32
          x-stainless-terraform-configurability: optional
        failingCount:
          type: integer
          title: failing_count
          format: int32
          x-stainless-terraform-configurability: optional
        warningCount:
          type: integer
          title: warning_count
          format: int32
          x-stainless-terraform-configurability: optional
        passingCount:
          type: integer
          title: passing_count
          format: int32
          x-stainless-terraform-configurability: optional
        runningCount:
          type: integer
          title: running_count
          format: int32
          x-stainless-terraform-configurability: optional
        noDataCount:
          type: integer
          title: no_data_count
          format: int32
          x-stainless-terraform-configurability: optional
        canceledCount:
          type: integer
          title: canceled_count
          format: int32
          x-stainless-terraform-configurability: optional
      title: JourneyHealthCheckCounts
      additionalProperties: false
      description: Aggregate counts of health checks across a journey.
    svhelp.pubapimodels.CustomFieldValueSummary:
      type: object
      properties:
        fieldId:
          type: string
          title: field_id
          x-stainless-terraform-configurability: optional
        fieldKey:
          type: string
          title: field_key
          x-stainless-terraform-configurability: optional
        fieldName:
          type: string
          title: field_name
          x-stainless-terraform-configurability: optional
        dataType:
          $ref: '#/components/schemas/svstore.EntityTypeField.DataType'
          title: data_type
          x-stainless-terraform-configurability: optional
        value:
          $ref: '#/components/schemas/google.protobuf.Value'
          title: value
          x-stainless-terraform-configurability: optional
      title: CustomFieldValueSummary
      additionalProperties: false
    svhelp.pubapimodels.JourneyMetadata.Onboarding:
      type: object
      title: Onboarding
      properties:
        onboarding:
          $ref: '#/components/schemas/svhelp.pubapimodels.OnboardingJourneyMetadata'
          title: onboarding
          x-stainless-terraform-configurability: optional
        welcomeTitle:
          type: string
          title: welcome_title
          description: >-
            Salutation shown at the top of the journey view, common to every
            journey
             type. welcome_title overrides the default heading; welcome_body overrides
             the default body copy and supersedes the legacy
             OnboardingJourneyMetadata.welcome_message.
          nullable: true
          x-stainless-terraform-configurability: optional
        welcomeBody:
          type: string
          title: welcome_body
          nullable: true
          x-stainless-terraform-configurability: optional
      required:
        - onboarding
      additionalProperties: false
    svstore.EntityTypeField.DataType:
      type: string
      title: DataType
      enum:
        - DATA_TYPE_UNSPECIFIED
        - TEXT
        - NUMBER
        - BOOL
        - TIMESTAMP
        - ENUM
        - ENTITY_REF
        - USER_REF
        - UNIQUE
        - MULTI_SELECT
        - FILE
    google.protobuf.Value:
      oneOf:
        - type: 'null'
        - type: number
        - type: string
        - type: boolean
        - type: array
        - type: object
          additionalProperties: true
      description: |-
        `Value` represents a dynamically typed value which can be either
         null, a number, a string, a boolean, a recursive struct value, or a
         list of values. A producer of value is expected to set one of these
         variants. Absence of any variant indicates an error.

         The JSON representation for `Value` is JSON value.
    svhelp.pubapimodels.OnboardingJourneyMetadata:
      type: object
      properties:
        startDate:
          $ref: '#/components/schemas/google.type.Date'
          title: start_date
          x-stainless-terraform-configurability: optional
        welcomeMessage:
          type: string
          title: welcome_message
          nullable: true
          x-stainless-terraform-configurability: optional
      title: OnboardingJourneyMetadata
      additionalProperties: false
      description: Metadata for an onboarding journey.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````