---
title: "GET /v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessages"
method: GET
path: "/v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessages"
---

# GET /v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessages

`GET /v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessages`

Retrieves the in-app messages targeted for the provided endpoint ID.

## Path parameters

- `application-id` string, required
- `endpoint-id` string, required

## Response `200`

Success

- GetInAppMessagesResponse
  - `InAppMessagesResponse` InAppMessagesResponse, required — Get in-app messages response object.
    - `InAppMessageCampaigns` InAppMessageCampaign[] — List of targeted in-app message campaigns.
      - `CampaignId` string — Campaign id of the corresponding campaign.
      - `DailyCap` integer — Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
      - `InAppMessage` object — In-app message content with all fields required for rendering an in-app message.
        - `Content` InAppMessageContent[] — In-app message content.
          - `BackgroundColor` string — The background color for the message.
          - `BodyConfig` object — The configuration for the message body.
            - `Alignment` 'LEFT' | 'CENTER' | 'RIGHT', required — The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
            - `Body` string, required — Message Body.
            - `TextColor` string, required — The text color.
          - `HeaderConfig` object — The configuration for the message header.
            - `Alignment` 'LEFT' | 'CENTER' | 'RIGHT', required — The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
            - `Header` string, required — Message Header.
            - `TextColor` string, required — The text color.
          - `ImageUrl` string — The image url for the background of message.
          - `PrimaryBtn` object — The first button inside the message.
            - `Android` object — Default button content.
              - …
            - `DefaultConfig` object — Default button content.
              - …
            - `IOS` object — Default button content.
              - …
            - `Web` object — Default button content.
              - …
          - `SecondaryBtn` object — The second button inside message.
            - `Android` object — Default button content.
              - …
            - `DefaultConfig` object — Default button content.
              - …
            - `IOS` object — Default button content.
              - …
            - `Web` object — Default button content.
              - …
        - `CustomConfig` object — Custom config to be sent to SDK.
        - `Layout` 'BOTTOM_BANNER' | 'TOP_BANNER' | 'OVERLAYS' | 'MOBILE_FEED' | 'MIDDLE_BANNER' | 'CAROUSEL' — The layout of the message.
      - `Priority` integer — Priority of the in-app message.
      - `Schedule` object — Schedule of the campaign.
        - `EndDate` string — The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.
        - `EventFilter` object — The event filter the SDK has to use to show the in-app message in the application.
          - `Dimensions` object, required — The dimension settings of the event filter for the campaign.
            - `Attributes` object — One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
            - `EventType` object — The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html">Streaming Amazon Pinpoint Events</a> in the <i>Amazon Pinpoint Developer Guide</i>.
              - …
            - `Metrics` object — One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
          - `FilterType` 'SYSTEM' | 'ENDPOINT', required — The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (<link linkend="apps-application-id-events">Events</link> resource) occurs.
        - `QuietTime` object — Time during which the in-app message should not be shown to the user.
          - `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.
      - `SessionCap` integer — Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
      - `TotalCap` integer — Total cap which controls the number of times an in-app message can be shown to the endpoint.
      - `TreatmentId` string — Treatment id of the campaign.

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