API ReferenceSites

List Sites

Retrieve a paginated list of sites. Results can be filtered by account, state, city, or zipcode.

Authentication

x-api-keystring
API Key authentication via header

Query parameters

accountIdintegerOptional
Filter by account ID.
statestringOptional

Filter by state, case-insensitive (e.g. ca or CA).

citystringOptional

Filter by city, case-insensitive substring match (e.g. francisco matches San Francisco).

zipcodestringOptional

Filter by zip code, case-insensitive.

pageintegerOptional>=1Defaults to 1

Page number (1-based)

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

Response

List of sites
idinteger
Unique site ID.
accountIdinteger
ID of the account this site belongs to.
titlestring or null

Human-readable label for the site (e.g. “Main Office”).

fullAddressstring or null
Full formatted address string.
streetstring or null
citystring or null
statestring or null
zipcodestring or null
geoLocationstring or null

Latitude/longitude as “lat,lng” (e.g. “37.7749,-122.4194”).

timezonestring or null

IANA timezone string (e.g. “America/Los_Angeles”).

createdAtstring or nullformat: "date-time"
updatedAtstring or nullformat: "date-time"

Errors

400
Bad Request Error
401
Unauthorized Error