Retrieves all bodies of water.
query Parameters
includeDeletedHeaders
skimmer-api-keyThe skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Retrieves all bodies of water. › Responses
OK
nameName of the pool.
idThe unique identifier for the pool.
serviceLocationIdThe Service Location ID this pool belongs to.
deletedIndicates whether the pool has been marked as deleted.
gallonsThe volume of water in the pool, measured in gallons.
baselineFilterPressureThe baseline pressure reading of the pool's filter system, measured in PSI.
notesAdditional notes or comments about the pool.
Updates an existing body of water.
Headers
skimmer-api-keyThe skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Updates an existing body of water. › Request Body
idThe unique identifier for the pool.
nameName of the pool.
gallonsThe volume of water in the pool, measured in gallons.
baselineFilterPressureThe baseline pressure reading of the pool's filter system, measured in PSI.
notesAdditional notes or comments about the pool.
Updates an existing body of water. › Responses
OK
idThe unique identifier for the pool.
nameName of the pool.
gallonsThe volume of water in the pool, measured in gallons.
baselineFilterPressureThe baseline pressure reading of the pool's filter system, measured in PSI.
notesAdditional notes or comments about the pool.
Creates a new body of water.
Headers
skimmer-api-keyThe skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Creates a new body of water. › Request Body
serviceLocationIdThe Service Location ID this pool belongs to.
nameName of the pool.
gallonsThe volume of water in the pool, measured in gallons.
baselineFilterPressureThe baseline pressure reading of the pool's filter system, measured in PSI.
notesAdditional notes or comments about the pool.
Creates a new body of water. › Responses
Created
idThe unique identifier for the pool.
nameName of the pool.
gallonsThe volume of water in the pool, measured in gallons.
baselineFilterPressureThe baseline pressure reading of the pool's filter system, measured in PSI.
notesAdditional notes or comments about the pool.
Searches all bodies of water.
query Parameters
SortsComma-delimited ordered list of property names to sort by. Adding - before the property name sorts in reverse order.Values: Id, Name, Gallons, BaselineFilterPressure, CreatedAt, UpdatedAt
FiltersA comma-delimited list of property name, operator, value.Values: Id, Name, Gallons, BaselineFilterPressure, CreatedAt, UpdatedAt, Deleted
PageThe page number to return
PageSizeThe number of items returned per page
Headers
skimmer-api-keyThe skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Searches all bodies of water. › Responses
OK
nameName of the pool.
idThe unique identifier for the pool.
serviceLocationIdThe Service Location ID this pool belongs to.
deletedIndicates whether the pool has been marked as deleted.
gallonsThe volume of water in the pool, measured in gallons.
baselineFilterPressureThe baseline pressure reading of the pool's filter system, measured in PSI.
notesAdditional notes or comments about the pool.
Retrieves one body of water by ID.
path Parameters
idquery Parameters
includeDeletedHeaders
skimmer-api-keyThe skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Retrieves one body of water by ID. › Responses
OK
nameName of the pool.
idThe unique identifier for the pool.
serviceLocationIdThe Service Location ID this pool belongs to.
deletedIndicates whether the pool has been marked as deleted.
gallonsThe volume of water in the pool, measured in gallons.
baselineFilterPressureThe baseline pressure reading of the pool's filter system, measured in PSI.
notesAdditional notes or comments about the pool.