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

Get Inbox Message

Path Params
string
required

The unique code identifying the partner program context for which the inbox messages are retrieved.

string
required

The unique identifier of the account whose inbox messages are being retrieved.

Query Params
int32

Optional. The category key to filter messages by category. Valid values: 0-18.

string

Optional. Keywords to filter messages by content.

int32

Optional. The paging offset for message retrieval. Default is 0.

int32

Optional. The maximum number of messages to return. Default is 50.

string

Optional. The unique identifier of the SCC account for cross-account message retrieval.

Headers
string
required

The unique request identifier (GUID) for tracking and idempotency. Required in the X-GD-RequestId header.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json