v1
latestOpenAPI 3.0.12026-07-243407211.3 MBNotification
Get Inbox Messages – Retrieves inbox messages for an account, with optional filtering and pagination.
Get Inbox Message
get/programs/{programCode}/accounts/{accountIdentifier}/inbox/messages
Path parameters
programCodestring required
The unique code identifying the partner program context for which the inbox messages are retrieved.
accountIdentifierstring required
The unique identifier of the account whose inbox messages are being retrieved.
Query parameters
categoryKeyinteger
Optional. The category key to filter messages by category. Valid values: 0-18.
keyWordsstring
Optional. Keywords to filter messages by content.
offsetinteger
Optional. The paging offset for message retrieval. Default is 0.
limitinteger
Optional. The maximum number of messages to return. Default is 50.
sccAccountIdentifierstring
Optional. The unique identifier of the SCC account for cross-account message retrieval.
Headers
X-GD-RequestIdstring required
The unique request identifier (GUID) for tracking and idempotency. Required in the X-GD-RequestId header.
Response
OK