atlas

List Inbox Messages

List Inbox Messages, sorted by effectiveFrom in descending order

get/atlas/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/atlas/v1/inbox-messages
  • Auth: OAuth 2 (implicit, authorization URL "")

Query parameters

effectiveFrom_gtestring

filters on inbox message whose effective from is greater than or equal to this value

status_instring[]

filters on inbox message whose status matches one of the provided values

parentType_instring[]

filters on inbox message whose parent type matches one of the provided values

offsetinteger

offset

limitinteger

limit

Response

InboxMessageList

totalCountinteger

Changes

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