Skimmer.PublicApi.Host | v1

BodiesOfWater

Endpoint:https://publicapi.getskimmer.com

Retrieves all bodies of water.

GET

https://publicapi.getskimmer.com

/BodiesOfWater

Retrieves all bodies of water. › query Parameters

includeDeletedboolean
Default: false

Retrieves all bodies of water. › Headers

skimmer-api-keystring · required
The 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

namestring | null · required
Name of the pool.

idstring | null
The unique identifier for the pool.
serviceLocationIdstring | null
The Service Location ID this pool belongs to.
deletedboolean
Indicates whether the pool has been marked as deleted.
gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Updates an existing body of water.

PUT

https://publicapi.getskimmer.com

/BodiesOfWater

Updates an existing body of water. › Headers

skimmer-api-keystring · required
The 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

idstring | null · required
The unique identifier for the pool.
namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Updates an existing body of water. › Responses

idstring | null · required
The unique identifier for the pool.
namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Creates a new body of water.

POST

https://publicapi.getskimmer.com

/BodiesOfWater

Creates a new body of water. › Headers

skimmer-api-keystring · required
The 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

serviceLocationIdstring · required
The Service Location ID this pool belongs to.
namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Creates a new body of water. › Responses

Created

idstring | null · required
The unique identifier for the pool.
namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Searches all bodies of water.

GET

https://publicapi.getskimmer.com

/BodiesOfWater/search

Searches all bodies of water. › query Parameters

Sortsstring
Comma-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
Filtersstring
A comma-delimited list of property name, operator, value.Values: Id, Name, Gallons, BaselineFilterPressure, CreatedAt, UpdatedAt, Deleted
Pageinteger · int32
The page number to return
PageSizeinteger · int32
The number of items returned per page

Searches all bodies of water. › Headers

skimmer-api-keystring · required
The 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

namestring | null · required
Name of the pool.

idstring | null
The unique identifier for the pool.
serviceLocationIdstring | null
The Service Location ID this pool belongs to.
deletedboolean
Indicates whether the pool has been marked as deleted.
gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Retrieves one body of water by ID.

GET

https://publicapi.getskimmer.com

/BodiesOfWater/{id}

Retrieves one body of water by ID. › path Parameters

idstring · required

Retrieves one body of water by ID. › query Parameters

includeDeletedboolean
Default: false

Retrieves one body of water by ID. › Headers

skimmer-api-keystring · required
The 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

namestring | null · required
Name of the pool.

idstring | null
The unique identifier for the pool.
serviceLocationIdstring | null
The Service Location ID this pool belongs to.
deletedboolean
Indicates whether the pool has been marked as deleted.
gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Deletes an existing body of water.

DELETE

https://publicapi.getskimmer.com

/BodiesOfWater/{id}

Deletes an existing body of water. › path Parameters

idstring · required

Deletes an existing body of water. › Headers

skimmer-api-keystring · required
The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Deletes an existing body of water. › Responses

No Content

No data returned

Customers Billing

Retrieves all bodies of water.

GET

https://publicapi.getskimmer.com

/BodiesOfWater

Retrieves all bodies of water. › query Parameters

includeDeletedboolean
Default: false

Retrieves all bodies of water. › Headers

skimmer-api-keystring · required
The 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

namestring | null · required
Name of the pool.

idstring | null
The unique identifier for the pool.
serviceLocationIdstring | null
The Service Location ID this pool belongs to.
deletedboolean
Indicates whether the pool has been marked as deleted.
gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Updates an existing body of water.

PUT

https://publicapi.getskimmer.com

/BodiesOfWater

Updates an existing body of water. › Headers

skimmer-api-keystring · required
The 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

idstring | null · required
The unique identifier for the pool.
namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Updates an existing body of water. › Responses

idstring | null · required
The unique identifier for the pool.
namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Creates a new body of water.

POST

https://publicapi.getskimmer.com

/BodiesOfWater

Creates a new body of water. › Headers

skimmer-api-keystring · required
The 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

serviceLocationIdstring · required
The Service Location ID this pool belongs to.
namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Creates a new body of water. › Responses

Created

idstring | null · required
The unique identifier for the pool.
namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Searches all bodies of water.

GET

https://publicapi.getskimmer.com

/BodiesOfWater/search

Searches all bodies of water. › query Parameters

Sortsstring
Comma-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
Filtersstring
A comma-delimited list of property name, operator, value.Values: Id, Name, Gallons, BaselineFilterPressure, CreatedAt, UpdatedAt, Deleted
Pageinteger · int32
The page number to return
PageSizeinteger · int32
The number of items returned per page

Searches all bodies of water. › Headers

skimmer-api-keystring · required
The 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

namestring | null · required
Name of the pool.

idstring | null
The unique identifier for the pool.
serviceLocationIdstring | null
The Service Location ID this pool belongs to.
deletedboolean
Indicates whether the pool has been marked as deleted.
gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Retrieves one body of water by ID.

GET

https://publicapi.getskimmer.com

/BodiesOfWater/{id}

Retrieves one body of water by ID. › path Parameters

idstring · required

Retrieves one body of water by ID. › query Parameters

includeDeletedboolean
Default: false

Retrieves one body of water by ID. › Headers

skimmer-api-keystring · required
The 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

namestring | null · required
Name of the pool.

idstring | null
The unique identifier for the pool.
serviceLocationIdstring | null
The Service Location ID this pool belongs to.
deletedboolean
Indicates whether the pool has been marked as deleted.
gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Deletes an existing body of water.

DELETE

https://publicapi.getskimmer.com

/BodiesOfWater/{id}

Deletes an existing body of water. › path Parameters

idstring · required

Deletes an existing body of water. › Headers

skimmer-api-keystring · required
The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Deletes an existing body of water. › Responses

No Content

No data returned