Skip to main content
GET
List locations for a project

Authorizations

x-api-key
string
header
required

API key minted in the MarketBox dashboard. Scope is restricted to the projects you select at creation time. Every route needs the key's standard API access (*) except POST /v1/projects/{projectId}/events, which needs events:write; a key without * is refused with 403 CAPABILITY_NOT_GRANTED.

Path Parameters

projectId
string
required

The project (tenant) that owns the resource. Every resource in this API is scoped to a project, and your API key is restricted to the projects it was issued for — a project outside that scope returns 403.

Minimum string length: 1
Example:

"prj_01kv60qgnef2kt3pvqgwmkbzfr"

Query Parameters

locationType
enum<string>

Only locations of this type. With it, the list is sorted by name; without it, by id.

Available options:
PHYSICAL,
VIRTUAL,
TRAVEL_ZONE
Example:

"PHYSICAL"

includeInactive
enum<string>

Also return inactive locations (active: false). Deleted locations are never returned.

Available options:
true,
false
Example:

"false"

namePrefix
string

Only locations whose name starts with this text, compared case-insensitively (against nameNormalized). Requires locationType: sent without it, the request is refused with 400 VALIDATION_ERROR.

Minimum string length: 1
Example:

"bondi"

Response

Locations list

data
object[]
required