Pool Service Software (PSS) includes a Public API that lets your company connect PSS to other software — reporting dashboards, CRMs, custom integrations, or automation tools. The API gives programmatic access to the same data you manage in the web app: clients, properties, service routes, jobs, invoices, visits, catalog items, and team members.
This section explains what the API can do, how to activate it, what it costs, how to create and manage API keys, and how each resource behaves. It is written so that a company owner or office manager can decide whether the API fits their needs and get a developer started, and it doubles as the reference the PSS support team uses when an integration question comes in.
Note: The full technical reference — every endpoint, field table, and JSON example — is published on the developer portal at https://developers.poolservice.software. That portal always reflects the current OpenAPI specification. This section is the guide layer on top of it.
The PSS Public API is a cloud-hosted REST API. Key characteristics:
- REST over HTTPS — standard
GET,POST,PUT,PATCH, andDELETErequests with JSON request and response bodies. - API-key authentication — every request (except the health check) requires a company API key sent in a request header.
- Company-scoped — the API key identifies your company. All data returned belongs to your company only; you never pass a company ID in requests.
- UUID identifiers — every entity ID in the API (client, property, job, invoice, etc.) is a UUID string. Internal database IDs are never exposed.
Base URLs
- API —
https://api.poolservice.software— your live company data. - Developer portal —
https://developers.poolservice.software— interactive API reference and OpenAPI specification.
Note: The developer portal serves the interactive reference at
/and/docs, and the raw specification at/openapi.yaml. API keys are created in the PSS web app and work againsthttps://api.poolservice.software.