---
title: "Get Inbox Messages – Retrieves inbox messages for an account, with optional filtering and pagination."
method: GET
path: "/programs/{programCode}/accounts/{accountIdentifier}/inbox/messages"
tags: ["Notification"]
---

# Get Inbox Messages – Retrieves inbox messages for an account, with optional filtering and pagination.

`GET /programs/{programCode}/accounts/{accountIdentifier}/inbox/messages`

Get Inbox Message

## Path parameters

- `programCode` string, required
- `accountIdentifier` string, required

## Query parameters

- `categoryKey` integer
- `keyWords` string
- `offset` integer
- `limit` integer
- `sccAccountIdentifier` string

## Headers

- `X-GD-RequestId` string, required

## Response `200`

OK

- GetInboxMessageResponse — Represents the response returned after retrieving inbox messages for an account. Contains the total count of messages and a list of inbox message objects, each with message details, status, and metadata. Used to provide paginated message data for display, management, or notification purposes within a partner program.
  - `count` integer — The total number of inbox messages matching the request criteria. Used for pagination and to indicate the size of the result set.
  - `inboxMessages` InboxMessage[], nullable — The list of inbox messages returned in the response. Each message includes details such as subject, content, read status, category, format, creation date, and account association.
    - `messageKey` integer — The unique key identifying the inbox message. Used for message retrieval, management, and tracking.
    - `subject` string, nullable — The subject or title of the inbox message. Provides a brief summary or headline for the message content.
    - `message` string, nullable — The body content of the inbox message. Contains the full text or HTML of the notification or communication.
    - `isRead` boolean — Indicates whether the inbox message has been read by the user. True if the message has been opened or marked as read; otherwise, false.
    - `notificationTypeKey` integer — The key representing the notification type for the message (e.g., transaction alert, account update). Used to categorize the message by its notification purpose.
    - `categoryKey` integer — The key representing the category of the message. Used to group messages by business or functional category.
    - `category` string, nullable — The name or description of the message category. Provides a human-readable label for the message's category.
    - `format` 'Alerts' | 'Email' | 'Link' — The format of the inbox message, such as alerts, email, or link. Defined by the Gd.Bos.DataTransfer.InboxMessage.Format enumeration: Alerts, Email, Link.
    - `createDate` string, date-time — The date and time when the inbox message was created, in ISO 8601 format. Used for sorting, filtering, and display purposes.
    - `accountIdentifier` string, nullable — The unique identifier of the account associated with the inbox message. Used to scope the message to the correct user or account.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)