Skip to content

List all locations

GET
/locations

Retrieve a paginated list of locations

page
integer
default: 1
page_size
integer
default: 50
location_type
string
owner_id
string
organization_id
string

List of locations

object
data
Array
total
integer
page
integer
page_size
integer
has_more
boolean
data
Array<object>
object
id
string
company_id
string
name
string | null
address1
string | null
address2
string | null
city
string | null
state
string | null
postal_code
string | null
geo_lat
number | null
geo_lon
number | null
geo_hash
string | null
date_created
string format: date-time
date_updated
string format: date-time
geocoder
string | null
metadata
object | null
geo_quality
string | null
external_id
string | null
owner_id
string | null
full_address
string | null
sales_rep_id
string | null
location_type
string | null
organization_id
string | null
fuel_ship_to
boolean
fuel_transport
boolean
preferences
object | null
description
string | null
sync
boolean
note
string | null

Unauthorized

object
success
required
boolean
error
required
string
Example
An error occurred