---
title: "GET /v1/apps/{application-id}/journeys"
method: GET
path: "/v1/apps/{application-id}/journeys"
---

# GET /v1/apps/{application-id}/journeys

`GET /v1/apps/{application-id}/journeys`

Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.

## Path parameters

- `application-id` string, required

## Query parameters

- `page-size` string
- `token` string

## Response `200`

Success

- ListJourneysResponse
  - `JourneysResponse` JourneysResponse, required — Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.
    - `Item` JourneyResponse[], required — An array of responses, one for each journey that's associated with the application.
      - `Activities` object — A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
      - `ApplicationId` string, required — The unique identifier for the application that the journey applies to.
      - `CreationDate` string — The date, in ISO 8601 format, when the journey was created.
      - `Id` string, required — The unique identifier for the journey.
      - `LastModifiedDate` string — The date, in ISO 8601 format, when the journey was last modified.
      - `Limits` object — The messaging and entry limits for the journey.
        - `DailyCap` integer — The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
        - `EndpointReentryCap` integer — The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
        - `MessagesPerSecond` integer — The maximum number of messages that the journey can send each second.
        - `EndpointReentryInterval` string — Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
      - `LocalTime` boolean — Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
      - `Name` string, required — The name of the journey.
      - `QuietTime` object — <p>The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:</p> <ul><li><p>The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.</p></li> <li><p>The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.</p></li> <li><p>The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.</p></li></ul> <p>If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.</p>
        - `End` string — The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        - `Start` string — The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
      - `RefreshFrequency` string — The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
      - `Schedule` object — The schedule settings for the journey.
        - `EndTime` string, date-time — The scheduled time, in ISO 8601 format, when the journey ended or will end.
        - `StartTime` string, date-time — The scheduled time, in ISO 8601 format, when the journey began or will begin.
        - `Timezone` string — The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
      - `StartActivity` string — The unique identifier for the first activity in the journey.
      - `StartCondition` object — The segment that defines which users are participants in the journey.
        - `Description` string — The custom description of the condition.
        - `EventStartCondition` EventStartCondition — Specifies the settings for an event that causes a journey activity to start.
          - `EventFilter` EventFilter — Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
            - `Dimensions` object, required — The dimensions for the event filter to use for the campaign or the journey activity.
              - …
            - `FilterType` 'SYSTEM' | 'ENDPOINT', required — The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (<link linkend="apps-application-id-events">Events resource</link>) occurs.
          - `SegmentId` string
        - `SegmentStartCondition` object — The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
          - `SegmentId` string, required — The unique identifier for the segment to associate with the activity.
      - `State` 'DRAFT' | 'ACTIVE' | 'COMPLETED' | 'CANCELLED' | 'CLOSED' | 'PAUSED' — <p>The current status of the journey. Possible values are:</p> <ul><li><p>DRAFT - The journey is being developed and hasn't been published yet.</p></li> <li><p>ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.</p></li> <li><p>COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.</p></li> <li><p>CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.</p></li> <li><p>CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.</p></li></ul>
      - `tags` object — This object is not used or supported.
      - `WaitForQuietTime` boolean — Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
      - `RefreshOnSegmentUpdate` boolean — Specifies whether a journey should be refreshed on segment update.
      - `JourneyChannelSettings` object — The channel-specific configurations for the journey.
        - `ConnectCampaignArn` string — Amazon Resource Name (ARN) of the Connect Campaign.
        - `ConnectCampaignExecutionRoleArn` string — IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
      - `SendingSchedule` boolean — Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)
      - `OpenHours` object — The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
        - `EMAIL` object — Rules for Email Channel.
        - `SMS` object — Rules for SMS Channel.
        - `PUSH` object — Rules for Push Channel.
        - `VOICE` object — Rules for Voice Channel.
        - `CUSTOM` object — Rules for Custom Channel.
      - `ClosedDays` object — The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
        - `EMAIL` object[] — Rules for Email Channel.
          - `Name` string — Name of the rule.
          - `StartDateTime` string — Start Datetime in ISO 8601 format.
          - `EndDateTime` string — End Datetime in ISO 8601 format.
        - `SMS` object[] — Rules for SMS Channel.
          - `Name` string — Name of the rule.
          - `StartDateTime` string — Start Datetime in ISO 8601 format.
          - `EndDateTime` string — End Datetime in ISO 8601 format.
        - `PUSH` object[] — Rules for Push Channel.
          - `Name` string — Name of the rule.
          - `StartDateTime` string — Start Datetime in ISO 8601 format.
          - `EndDateTime` string — End Datetime in ISO 8601 format.
        - `VOICE` object[] — Rules for Voice Channel.
          - `Name` string — Name of the rule.
          - `StartDateTime` string — Start Datetime in ISO 8601 format.
          - `EndDateTime` string — End Datetime in ISO 8601 format.
        - `CUSTOM` object[] — Rules for Custom Channel.
          - `Name` string — Name of the rule.
          - `StartDateTime` string — Start Datetime in ISO 8601 format.
          - `EndDateTime` string — End Datetime in ISO 8601 format.
    - `NextToken` string — The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

## Other responses

- `480` — BadRequestException
- `481` — InternalServerErrorException
- `482` — PayloadTooLargeException
- `483` — ForbiddenException
- `484` — NotFoundException
- `485` — MethodNotAllowedException
- `486` — TooManyRequestsException

---

[API](https://skmtc.net/aws/apis/pinpoint.md) · [All operations](https://skmtc.net/aws/apis/pinpoint/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pinpoint/versions/c0cf580f498b/schema)