Skip to main content
GET
List locations

Authorizations

Authorization
string
header
required

Organization API key with an sk_live_ or sk_test_ prefix

Query Parameters

limit
integer
default:20

Maximum number of items to return from a Canary-native list (1-100)

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

Pagination cursor from previous response

direction
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
expand
enum<string>

Include custom-field values on list records

Available options:
extra_fields

Response

List of locations

data
object[]
required
meta
object
required