Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Merchant secret key, or an authorized Platform secret key with delegation.

Headers

Ionic-Account
string

Merchant ID when an authorized Platform acts for a connected Merchant. Omit when authenticating directly as that Merchant.

Pattern: ^mer_[0-9A-Za-z]{14}$

Query Parameters

limit
integer
default:20

Page size. Defaults to 20 and cannot exceed 100.

Required range: 1 <= x <= 100
starting_after
string

Return objects after this Location ID.

Pattern: ^loc_[0-9A-Za-z]{14}$

Response

A page of Locations.

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required
next_cursor
string

Present only when has_more is true.

Pattern: ^loc_[0-9A-Za-z]{14}$