lighthouse

List inbox messages

List inbox messages, sorted by effectiveFrom in descending order

get/lighthouse/v1/inbox-messages

Request

  • Base URL: https://api.beamcheckout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.beamcheckout.com/lighthouse/v1/inbox-messages
  • Auth: OAuth 2 (implicit, authorization URL "")

Query parameters

cursorstring

cursor

limitinteger

limit

category'ANNOUNCEMENT' | 'CAMPAIGN'

filters on inbox message whose category matches the provided values

Headers

x-beam-merchant-idstring required

x-beam-merchant-id

Response

ListInboxMessages

nextCursorstring

empty string if no next cursor

Changes

No recorded changes to this operation across all 1 revision of this API.