Your workflows.
Connected by design.

Start with a read.

Create a key in your club’s console under Club → Staff & tools → API keys. Choose the scopes your integration needs and store the key in its secure configuration. For this example, include members:read.

Set SWIMOPS_ORIGIN to your club’s HTTPS origin and SWIMOPS_API_KEY to your key in your local environment, then request the first page of households:

curl --get "$SWIMOPS_ORIGIN/api/v1/ops/households.list" \
  --header "Authorization: Bearer $SWIMOPS_API_KEY" \
  --data-urlencode "limit=25"

Use your club’s host, not swimops.io. Monetary values are integer cents. Follow each operation’s response schema for its result and pagination fields.

A few useful conventions.

Authentication

Send your scoped key in the Authorization: Bearer header. Missing or invalid keys return 401; insufficient access returns 403.

Operation paths

The reference lists the HTTP method for each /api/v1/ops/<name> operation. GET inputs use query parameters; POST inputs use a JSON body.

Write requests

Supply an Idempotency-Key for supported writes. Reuse the same key and body when retrying the same request. Some operations require a preview and confirmation; follow their documented flow.

Conflicts & limits

A 409 response can mean confirmation is required, a key conflict, a request still running, or an abandoned request. Check the error before retrying. For rate limits (429), respect Retry-After.

Access boundaries

API keys are scoped to a club and do not expose every staff action. Use the connected AI workflow for supported actions that need browser approval.

Generated from the platform

Explore the endpoints.

Search by operation, domain, or description. Expand an endpoint for its parameters, request body, and response schemas.

Loading the API reference…

Data schemas.

Schema references in the endpoints above resolve to these definitions. For code generation or another documentation tool, use the complete OpenAPI JSON document.