Sites

Returns a list of sites. The list can be filtered by site name, address city, and address postal code.

get/sites

Query parameters

pageSizeinteger
'asc'
OR
'desc'
pageCursorstring
filterSiteNamestring
filterAddressCitystring
filterAddressPostalCodestring
'name'
OR
'createdAt'
filterSearchTextstring

Searchable fields:

  • name
  • defaultContact.firstName
  • defaultContact.lastName
  • customer.customerFullName
  • billingContact.firstName
  • billingContact.lastName
  • physicalAddress.address1
  • physicalAddress.address2

Response

Successful Response

resultstring required

Changes