v2

latestOpenAPI 3.1.02026-07-312954143.9 KB
Pricing Locations

List Pricing Locations

Get a list of pricing locations with optional filtering by ISOs, zones, zone types and a search term.

Args: params: Query parameters for filtering pricing locations sort_column: Column to sort by. sort_order: Sort order - 'asc' or 'desc'.

get/pricing_locations

Query parameters

sort_columnstring nullable
sort_order'asc' | 'desc'
api_keystring nullable

API key for authentication (query)

API key for authentication (query)

searchstring nullable

Optional search term to filter locations by name

Optional search term to filter locations by name

isosstring nullable

Comma-separated list of market IDs to filter by

Comma-separated list of market IDs to filter by

zonesstring nullable

Comma-separated list of zones to filter by

Comma-separated list of zones to filter by

statusstring nullable

Comma-separated list of statuses to filter by

Comma-separated list of statuses to filter by

location_typesstring nullable

Comma-separated list of location types to filter by

Comma-separated list of location types to filter by

has_geo_databoolean nullable

Filter by whether locations have geographic data

Filter by whether locations have geographic data

Headers

x-api-keystring nullable

API key for authentication (header)

API key for authentication (header)

Response

Successful Response

itemsobject[] required
total_itemsinteger required
facetsobject required