bridge

List Packages

List Packages, used by FA Admin to view all packages without restrictions, sort by created at in descending order

get/bridge/v1/packages

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/bridge/v1/packages
  • Auth: OAuth 2 (implicit, authorization URL "")

Query parameters

querystring

filters on packages whose name, id, or targeted merchant's tax id starts with the query (case insensitive)

isTargetedboolean

filters on packages whose is_targeted matches this value

status_instring[]

filters on packages whose status matches one of the provided values

offsetinteger

offset

limitinteger

limit

Headers

x-beam-partner-idstring required

x-beam-partner-id

Response

ok

totalCountinteger

Changes

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