{ "openapi": "3.1.0", "info": { "title": "Hapana Business API", "version": "2.0.0", "description": "Connect your own systems to your Hapana brand: locations, staff, classes, clients, bookings, check-ins, packages, payments and reports.\n\nAuthenticate with a brand API key from Control Center → API and Integrations → API keys. The full key is shown once, when you create it. Each key only reaches the scopes you grant it, and a request outside them is refused with 403.\n\nThe Business API is served from `public-api.hapana-app.com`. Apps that members sign in to use the Member API at `api.hapana-app.com` instead." }, "servers": [ { "url": "https://public-api.hapana-app.com", "description": "Production" }, { "url": "https://public-api.hapana-staging.com", "description": "Staging" }, { "url": "https://public-api.hapana-dev.com", "description": "Dev" }, { "url": "http://localhost:3021", "description": "Local" } ], "tags": [ { "name": "Sites", "description": "The locations in your brand." }, { "name": "Staff", "description": "The people who work at your locations." }, { "name": "Sessions", "description": "Scheduled classes." }, { "name": "Session staffing", "description": "Who is teaching a class." }, { "name": "Clients", "description": "Your members and prospects." }, { "name": "Bookings", "description": "Class bookings, waitlists and attendance." }, { "name": "Check-ins", "description": "Visits to a location, with or without a booking." }, { "name": "Client packages", "description": "Packages and memberships a client owns." }, { "name": "Payments", "description": "Payments taken, for reconciliation." }, { "name": "Reports", "description": "Run reports and export them as CSV." }, { "name": "Packages", "description": "The packages and memberships a location sells." }, { "name": "Reference", "description": "Ids you need when creating staff and classes." }, { "name": "Door access", "description": "Check-in eligibility for door and access-control systems." } ], "components": { "securitySchemes": { "partnerKey": { "type": "http", "scheme": "bearer", "description": "The brand API key, e.g. `hk_test_…`. Paste the value only, without `Bearer`." } } }, "security": [ { "partnerKey": [] } ], "paths": { "/public-api/v2/sites": { "get": { "tags": [ "Sites" ], "summary": "List sites", "description": "Every location in your brand.\n\n**Required scope:** `sites:read`", "operationId": "get_sites", "security": [ { "partnerKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "site" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "isDigital": { "type": "boolean" }, "addressStreet": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressCity": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressState": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressPostalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressCountry": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "regionName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "openingHours": { "anyOf": [ { "type": "object", "properties": { "everyDay": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "byDay": { "anyOf": [ { "type": "object", "properties": { "monday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "tuesday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "wednesday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "thursday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "friday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "saturday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "sunday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] } }, "required": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, { "type": "null" } ] } }, "required": [ "everyDay", "byDay" ] }, { "type": "null" } ] }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "name", "status", "isDigital", "addressStreet", "addressCity", "addressState", "addressPostalCode", "addressCountry", "latitude", "longitude", "regionName", "timezone", "openingHours", "legacyId", "createdAt" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } }, "post": { "tags": [ "Sites" ], "summary": "Create a site", "description": "Creates a location. Only the fields documented below are accepted; any other field is ignored.\n\n**Required scope:** `sites:write`", "operationId": "post_sites", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "workshopType": { "type": "string", "enum": [ "fitness", "yoga", "crossfit", "martial_arts", "swimming", "pilates", "dance", "cycling" ] }, "addressStreet": { "type": "string", "maxLength": 255 }, "addressCity": { "type": "string", "maxLength": 255 }, "addressState": { "type": "string", "maxLength": 255 }, "addressPostalCode": { "type": "string", "maxLength": 32 }, "addressCountry": { "type": "string", "maxLength": 255 }, "timezone": { "type": "string", "maxLength": 64 }, "phone": { "type": "string", "maxLength": 64 }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "name", "workshopType" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "site" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "isDigital": { "type": "boolean" }, "addressStreet": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressCity": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressState": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressPostalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressCountry": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "regionName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "openingHours": { "anyOf": [ { "type": "object", "properties": { "everyDay": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "byDay": { "anyOf": [ { "type": "object", "properties": { "monday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "tuesday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "wednesday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "thursday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "friday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "saturday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "sunday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] } }, "required": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, { "type": "null" } ] } }, "required": [ "everyDay", "byDay" ] }, { "type": "null" } ] }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "name", "status", "isDigital", "addressStreet", "addressCity", "addressState", "addressPostalCode", "addressCountry", "latitude", "longitude", "regionName", "timezone", "openingHours", "legacyId", "createdAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/sites/{id}": { "get": { "tags": [ "Sites" ], "summary": "Retrieve a site", "description": "**Required scope:** `sites:read`", "operationId": "get_sites__id_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "site" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "isDigital": { "type": "boolean" }, "addressStreet": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressCity": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressState": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressPostalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressCountry": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "regionName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "openingHours": { "anyOf": [ { "type": "object", "properties": { "everyDay": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "byDay": { "anyOf": [ { "type": "object", "properties": { "monday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "tuesday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "wednesday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "thursday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "friday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "saturday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "sunday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] } }, "required": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, { "type": "null" } ] } }, "required": [ "everyDay", "byDay" ] }, { "type": "null" } ] }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "name", "status", "isDigital", "addressStreet", "addressCity", "addressState", "addressPostalCode", "addressCountry", "latitude", "longitude", "regionName", "timezone", "openingHours", "legacyId", "createdAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } }, "patch": { "tags": [ "Sites" ], "summary": "Update a site", "description": "**Required scope:** `sites:write`", "operationId": "patch_sites__id_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "workshopType": { "type": "string", "enum": [ "fitness", "yoga", "crossfit", "martial_arts", "swimming", "pilates", "dance", "cycling" ] }, "addressStreet": { "type": "string", "maxLength": 255 }, "addressCity": { "type": "string", "maxLength": 255 }, "addressState": { "type": "string", "maxLength": 255 }, "addressPostalCode": { "type": "string", "maxLength": 32 }, "addressCountry": { "type": "string", "maxLength": 255 }, "timezone": { "type": "string", "maxLength": 64 }, "phone": { "type": "string", "maxLength": 64 }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "site" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "isDigital": { "type": "boolean" }, "addressStreet": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressCity": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressState": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressPostalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addressCountry": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "regionName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "openingHours": { "anyOf": [ { "type": "object", "properties": { "everyDay": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "byDay": { "anyOf": [ { "type": "object", "properties": { "monday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "tuesday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "wednesday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "thursday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "friday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "saturday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] }, "sunday": { "anyOf": [ { "type": "object", "properties": { "open": { "type": "string" }, "close": { "type": "string" } }, "required": [ "open", "close" ] }, { "type": "null" } ] } }, "required": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, { "type": "null" } ] } }, "required": [ "everyDay", "byDay" ] }, { "type": "null" } ] }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "name", "status", "isDigital", "addressStreet", "addressCity", "addressState", "addressPostalCode", "addressCountry", "latitude", "longitude", "regionName", "timezone", "openingHours", "legacyId", "createdAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/staff": { "get": { "tags": [ "Staff" ], "summary": "List staff", "description": "**Required scope:** `staff:read`", "operationId": "get_staff", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "format": "base64", "contentEncoding": "base64", "pattern": "^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "siteId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "active", "inactive" ] } }, { "name": "instructor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updatedSince", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "staff" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "employeeNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instructor": { "type": "boolean" }, "photoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "siteIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "homeSiteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workingHours": { "anyOf": [ { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "tuesday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "wednesday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "thursday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "friday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "saturday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "sunday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] } }, "required": [ "siteId", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, { "type": "null" } ] }, "qualifiedSessionTypeIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "firstName", "lastName", "email", "phone", "status", "employeeNumber", "instructor", "photoUrl", "bio", "siteIds", "homeSiteId", "timezone", "workingHours", "qualifiedSessionTypeIds", "legacyId", "createdAt", "updatedAt" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } }, "post": { "tags": [ "Staff" ], "summary": "Create a staff member", "description": "staffAccessPolicyId comes from GET /staff-access-policies and has no default: the policy decides what the new staff member can do in Hapana.\n\n**Required scope:** `staff:write`", "operationId": "post_staff", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 255 }, "lastName": { "type": "string", "minLength": 1, "maxLength": 255 }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "maxLength": 64 }, "staffAccessPolicyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteIds": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "firstName", "lastName", "email", "phone", "staffAccessPolicyId", "siteIds" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "staff" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "employeeNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instructor": { "type": "boolean" }, "photoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "siteIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "homeSiteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workingHours": { "anyOf": [ { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "tuesday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "wednesday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "thursday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "friday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "saturday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "sunday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] } }, "required": [ "siteId", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, { "type": "null" } ] }, "qualifiedSessionTypeIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "firstName", "lastName", "email", "phone", "status", "employeeNumber", "instructor", "photoUrl", "bio", "siteIds", "homeSiteId", "timezone", "workingHours", "qualifiedSessionTypeIds", "legacyId", "createdAt", "updatedAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/staff/{id}": { "get": { "tags": [ "Staff" ], "summary": "Retrieve a staff member", "description": "**Required scope:** `staff:read`", "operationId": "get_staff__id_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "staff" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "employeeNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instructor": { "type": "boolean" }, "photoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "siteIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "homeSiteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workingHours": { "anyOf": [ { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "tuesday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "wednesday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "thursday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "friday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "saturday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "sunday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] } }, "required": [ "siteId", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, { "type": "null" } ] }, "qualifiedSessionTypeIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "firstName", "lastName", "email", "phone", "status", "employeeNumber", "instructor", "photoUrl", "bio", "siteIds", "homeSiteId", "timezone", "workingHours", "qualifiedSessionTypeIds", "legacyId", "createdAt", "updatedAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } }, "patch": { "tags": [ "Staff" ], "summary": "Update a staff member", "description": "**Required scope:** `staff:write`", "operationId": "patch_staff__id_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 255 }, "lastName": { "type": "string", "minLength": 1, "maxLength": 255 }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "maxLength": 64 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "staff" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "employeeNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instructor": { "type": "boolean" }, "photoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "siteIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "homeSiteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workingHours": { "anyOf": [ { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "tuesday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "wednesday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "thursday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "friday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "saturday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] }, "sunday": { "anyOf": [ { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "required": [ "startTime", "endTime" ] }, { "type": "null" } ] } }, "required": [ "siteId", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, { "type": "null" } ] }, "qualifiedSessionTypeIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "firstName", "lastName", "email", "phone", "status", "employeeNumber", "instructor", "photoUrl", "bio", "siteIds", "homeSiteId", "timezone", "workingHours", "qualifiedSessionTypeIds", "legacyId", "createdAt", "updatedAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } }, "delete": { "tags": [ "Staff" ], "summary": "Deactivate a staff member", "description": "Deactivates rather than deletes, so the person’s bookings, check-ins and history are kept.\n\n**Required scope:** `staff:write`", "operationId": "delete_staff__id_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "responses": { "204": { "description": "No content" }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/sessions": { "get": { "tags": [ "Sessions" ], "summary": "List sessions in a date range", "description": "siteId, startDate and endDate are required. Each session includes the instructors assigned to it.\n\n**Required scope:** `sessions:read`", "operationId": "get_sessions", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "format": "base64", "contentEncoding": "base64", "pattern": "^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "siteId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED" ] } }, { "name": "sessionTypeId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "updatedSince", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "session" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "date": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED" ] }, "cancelled": { "type": "boolean" }, "capacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bookedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "spacesRemaining": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "waitlistEnabled": { "type": "boolean" }, "waitlistAvailable": { "type": "boolean" }, "durationMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sessionTypeId": { "type": "string" }, "scheduleTemplateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localStartTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localEndTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locationName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "roomName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sessionTypeName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instructors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "substitutingFor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "role", "substitutingFor" ] } } }, "required": [ "object", "id", "siteId", "name", "date", "startTime", "endTime", "status", "cancelled", "capacity", "bookedCount", "spacesRemaining", "waitlistEnabled", "waitlistAvailable", "durationMinutes", "sessionTypeId", "scheduleTemplateId", "timezone", "localStartTime", "localEndTime", "locationName", "roomName", "sessionTypeName", "legacyId", "instructors" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } }, "post": { "tags": [ "Sessions" ], "summary": "Create a session", "description": "Schedules a single class, not a recurring series. The request is refused if the class falls outside the room’s opening hours or the instructor’s working hours, or clashes with another class.\n\n**Required scope:** `sessions:write`", "operationId": "post_sessions", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "category": { "type": "string", "enum": [ "CLASS", "PRIVATE", "WORKSHOP" ] }, "date": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "siteSessionTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteLocationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "dropinPrice": { "type": "number", "minimum": 0 }, "capacity": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "siteId", "name", "category", "date", "startTime", "endTime", "siteSessionTypeId", "siteLocationId", "dropinPrice" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "session" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "date": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED" ] }, "cancelled": { "type": "boolean" }, "capacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bookedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "spacesRemaining": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "waitlistEnabled": { "type": "boolean" }, "waitlistAvailable": { "type": "boolean" }, "durationMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sessionTypeId": { "type": "string" }, "scheduleTemplateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localStartTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localEndTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locationName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "roomName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sessionTypeName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instructors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "substitutingFor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "role", "substitutingFor" ] } } }, "required": [ "object", "id", "siteId", "name", "date", "startTime", "endTime", "status", "cancelled", "capacity", "bookedCount", "spacesRemaining", "waitlistEnabled", "waitlistAvailable", "durationMinutes", "sessionTypeId", "scheduleTemplateId", "timezone", "localStartTime", "localEndTime", "locationName", "roomName", "sessionTypeName", "legacyId", "instructors" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/sessions/types": { "get": { "tags": [ "Sessions" ], "summary": "List session types", "description": "The class types you can create a session as.\n\n**Required scope:** `sessions:read`", "operationId": "get_sessions_types", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "session_type" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "object", "id", "siteId", "name", "category" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/sessions/templates": { "get": { "tags": [ "Sessions" ], "summary": "List schedule templates", "description": "The templates a site generates its classes from: the session type, the staff eligible to teach it (instructorIds) and the recurring hours it runs at (schedules). A session joins back here through scheduleTemplateId. An empty instructorIds means any instructor at the site may teach it. siteId is required.\n\n**Required scope:** `sessions:read`", "operationId": "get_sessions_templates", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "format": "base64", "contentEncoding": "base64", "pattern": "^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "session_template" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "type": "string", "enum": [ "CLASS", "PRIVATE", "WORKSHOP" ] }, "sessionTypeId": { "type": "string" }, "sessionTypeName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "durationMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "capacity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "locationId": { "type": "string" }, "roomId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instructorIds": { "description": "The staff marked as able to teach this template. Empty means unrestricted: any instructor at the site may teach it.", "type": "array", "items": { "type": "string" } }, "schedules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "recurrenceType": { "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY" ] }, "interval": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } }, { "type": "null" } ] }, "dayOfMonth": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "startDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "endDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "endAfterOccurrences": { "description": "Set when the series stops after this many classes rather than on a date. Null with a null endDate is an open-ended series.", "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "instructorIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "recurrenceType", "interval", "daysOfWeek", "dayOfMonth", "startTime", "endTime", "startDate", "endDate", "endAfterOccurrences", "instructorIds" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "siteId", "name", "description", "category", "sessionTypeId", "sessionTypeName", "durationMinutes", "capacity", "locationId", "roomId", "instructorIds", "schedules", "createdAt", "updatedAt" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/sessions/templates/{id}": { "get": { "tags": [ "Sessions" ], "summary": "Retrieve a schedule template", "description": "One template with its eligible instructors and recurring schedules.\n\n**Required scope:** `sessions:read`", "operationId": "get_sessions_templates__id_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "session_template" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "type": "string", "enum": [ "CLASS", "PRIVATE", "WORKSHOP" ] }, "sessionTypeId": { "type": "string" }, "sessionTypeName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "durationMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "capacity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "locationId": { "type": "string" }, "roomId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instructorIds": { "description": "The staff marked as able to teach this template. Empty means unrestricted: any instructor at the site may teach it.", "type": "array", "items": { "type": "string" } }, "schedules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "recurrenceType": { "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY" ] }, "interval": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } }, { "type": "null" } ] }, "dayOfMonth": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "startDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "endDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "endAfterOccurrences": { "description": "Set when the series stops after this many classes rather than on a date. Null with a null endDate is an open-ended series.", "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "instructorIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "recurrenceType", "interval", "daysOfWeek", "dayOfMonth", "startTime", "endTime", "startDate", "endDate", "endAfterOccurrences", "instructorIds" ] } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "siteId", "name", "description", "category", "sessionTypeId", "sessionTypeName", "durationMinutes", "capacity", "locationId", "roomId", "instructorIds", "schedules", "createdAt", "updatedAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/sessions/{id}": { "get": { "tags": [ "Sessions" ], "summary": "Retrieve a session", "description": "A class in a recurring series that has not been edited individually may have an id that is not a UUID. Pass the id exactly as GET /sessions returned it.\n\n**Required scope:** `sessions:read`", "operationId": "get_sessions__id_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "session" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "date": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED" ] }, "cancelled": { "type": "boolean" }, "capacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bookedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "spacesRemaining": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "waitlistEnabled": { "type": "boolean" }, "waitlistAvailable": { "type": "boolean" }, "durationMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sessionTypeId": { "type": "string" }, "scheduleTemplateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localStartTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localEndTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locationName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "roomName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sessionTypeName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instructors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "substitutingFor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "role", "substitutingFor" ] } } }, "required": [ "object", "id", "siteId", "name", "date", "startTime", "endTime", "status", "cancelled", "capacity", "bookedCount", "spacesRemaining", "waitlistEnabled", "waitlistAvailable", "durationMinutes", "sessionTypeId", "scheduleTemplateId", "timezone", "localStartTime", "localEndTime", "locationName", "roomName", "sessionTypeName", "legacyId", "instructors" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } }, "patch": { "tags": [ "Sessions" ], "summary": "Update a session", "description": "Changes the name, description, capacity or instructor. Setting instructorId replaces the current instructor without emailing anyone; use POST /sessions/{id}/substitute-instructor when members should be told. To move a class to a different time, use Control Center.\n\n**Required scope:** `sessions:write`", "operationId": "patch_sessions__id_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "maxLength": 2000 }, "capacity": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "instructorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "session" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "date": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED" ] }, "cancelled": { "type": "boolean" }, "capacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bookedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "spacesRemaining": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "waitlistEnabled": { "type": "boolean" }, "waitlistAvailable": { "type": "boolean" }, "durationMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sessionTypeId": { "type": "string" }, "scheduleTemplateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localStartTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localEndTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locationName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "roomName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sessionTypeName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instructors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "substitutingFor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "role", "substitutingFor" ] } } }, "required": [ "object", "id", "siteId", "name", "date", "startTime", "endTime", "status", "cancelled", "capacity", "bookedCount", "spacesRemaining", "waitlistEnabled", "waitlistAvailable", "durationMinutes", "sessionTypeId", "scheduleTemplateId", "timezone", "localStartTime", "localEndTime", "locationName", "roomName", "sessionTypeName", "legacyId", "instructors" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/sessions/{id}/cancel": { "post": { "tags": [ "Sessions" ], "summary": "Cancel a session", "description": "Releases every booking on the session: credits are returned and drop-in payments refunded. scope defaults to this occurrence only.\n\n**Required scope:** `sessions:write`", "operationId": "post_sessions__id__cancel", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "scope": { "default": "single", "type": "string", "enum": [ "single", "future" ] }, "notifyMembers": { "default": false, "type": "boolean" } }, "required": [ "siteId" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "session" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "date": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED" ] }, "cancelled": { "type": "boolean" }, "capacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bookedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "spacesRemaining": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "waitlistEnabled": { "type": "boolean" }, "waitlistAvailable": { "type": "boolean" }, "durationMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sessionTypeId": { "type": "string" }, "scheduleTemplateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localStartTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localEndTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locationName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "roomName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sessionTypeName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instructors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "substitutingFor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "role", "substitutingFor" ] } } }, "required": [ "object", "id", "siteId", "name", "date", "startTime", "endTime", "status", "cancelled", "capacity", "bookedCount", "spacesRemaining", "waitlistEnabled", "waitlistAvailable", "durationMinutes", "sessionTypeId", "scheduleTemplateId", "timezone", "localStartTime", "localEndTime", "locationName", "roomName", "sessionTypeName", "legacyId", "instructors" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/sessions/{id}/instructors": { "post": { "tags": [ "Session staffing" ], "summary": "Assign an instructor", "description": "Fills an empty instructor slot. No one is notified.\n\n**Required scope:** `sessions:write`", "operationId": "post_sessions__id__instructors", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "staffUserId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "role": { "default": "INSTRUCTOR", "type": "string", "enum": [ "INSTRUCTOR", "ASSISTANT", "SUBSTITUTE" ] } }, "required": [ "siteId", "staffUserId" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "staffUserId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "role": { "type": "string" } }, "required": [ "staffUserId", "role" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/sessions/{id}/instructors/{staffUserId}": { "delete": { "tags": [ "Session staffing" ], "summary": "Unassign an instructor", "description": "Identify the instructor by their staff id. Returns 204 whether or not they were assigned, so retrying after a timeout is safe.\n\n**Required scope:** `sessions:write`", "operationId": "delete_sessions__id__instructors__staffUserId_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "staffUserId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "responses": { "204": { "description": "No content" }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/sessions/{id}/substitute-instructor": { "post": { "tags": [ "Session staffing" ], "summary": "Substitute the instructor", "description": "Swaps one instructor for another and emails every booked member plus both instructors. Both ids are required.\n\n**Required scope:** `sessions:write`", "operationId": "post_sessions__id__substitute_instructor", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "instructorToRemoveId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "substituteInstructorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "notifyMembers": { "default": true, "type": "boolean" }, "notifyInstructors": { "default": false, "type": "boolean" } }, "required": [ "siteId", "instructorToRemoveId", "substituteInstructorId" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "session" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "date": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED" ] }, "cancelled": { "type": "boolean" }, "capacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bookedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "spacesRemaining": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "waitlistEnabled": { "type": "boolean" }, "waitlistAvailable": { "type": "boolean" }, "durationMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sessionTypeId": { "type": "string" }, "scheduleTemplateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localStartTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localEndTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locationName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "roomName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sessionTypeName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "legacyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instructors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "substitutingFor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "role", "substitutingFor" ] } } }, "required": [ "object", "id", "siteId", "name", "date", "startTime", "endTime", "status", "cancelled", "capacity", "bookedCount", "spacesRemaining", "waitlistEnabled", "waitlistAvailable", "durationMinutes", "sessionTypeId", "scheduleTemplateId", "timezone", "localStartTime", "localEndTime", "locationName", "roomName", "sessionTypeName", "legacyId", "instructors" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/clients/search": { "get": { "tags": [ "Clients" ], "summary": "Find a client", "description": "Resolve a caller to a client at one site by phone, email, or first and last name. Phone numbers match regardless of format: +61 412 345 678, 0412 345 678 and 412345678 are the same line. Returns up to 10 matches, because one number can belong to a whole family — never assume the first.\n\n**Required scope:** `clients:read`", "operationId": "get_clients_search", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "phone", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 32 } }, { "name": "email", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 320 } }, { "name": "firstName", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 50 } }, { "name": "lastName", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 50 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "client" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mobile": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fobNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dateOfBirth": { "description": "Returned only to a key that also holds clients:pii.", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "membershipStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "suspended": { "type": "boolean" }, "lastVisitAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "firstVisitAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "visitCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "joinedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "communicationPreferences": { "type": "object", "properties": { "email": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "sms": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "email", "sms", "phone" ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "HAPANA", "WEB", "APP", "STAFF", "KIOSK", "AGGREGATOR", "MIGRATION_IMPORTED", "APP_WEB_SIGNUP", "BUSINESS_ADDED", "EMBED_CREATED", "THIRD_PARTY", "CLIENT_REFERRAL", "SOCIAL_MEDIA" ] }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "siteId", "firstName", "lastName", "email", "mobile", "membershipStatus", "suspended", "lastVisitAt", "firstVisitAt", "visitCount", "joinedAt", "communicationPreferences", "source", "createdAt", "updatedAt" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/clients": { "get": { "tags": [ "Clients" ], "summary": "List clients at a site", "description": "Cursor-paginated. lastVisitBefore (a calendar day at the site) narrows to members whose last visit was before that day, and excludes anyone who has never visited; combine with membershipStatus to build a reactivation segment. updatedAfter (an ISO timestamp with offset) returns only clients whose details or membership at this site changed after it — store the time a sync started as the next watermark. Up to 500 per page. Always honour communicationPreferences before contacting anyone.\n\n**Required scope:** `clients:read`", "operationId": "get_clients", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "format": "base64", "contentEncoding": "base64", "pattern": "^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "lastVisitBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "membershipStatus", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "active", "suspended", "inactive" ] } }, { "name": "updatedAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "client" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mobile": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fobNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dateOfBirth": { "description": "Returned only to a key that also holds clients:pii.", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "membershipStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "suspended": { "type": "boolean" }, "lastVisitAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "firstVisitAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "visitCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "joinedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "communicationPreferences": { "type": "object", "properties": { "email": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "sms": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "email", "sms", "phone" ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "HAPANA", "WEB", "APP", "STAFF", "KIOSK", "AGGREGATOR", "MIGRATION_IMPORTED", "APP_WEB_SIGNUP", "BUSINESS_ADDED", "EMBED_CREATED", "THIRD_PARTY", "CLIENT_REFERRAL", "SOCIAL_MEDIA" ] }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "siteId", "firstName", "lastName", "email", "mobile", "membershipStatus", "suspended", "lastVisitAt", "firstVisitAt", "visitCount", "joinedAt", "communicationPreferences", "source", "createdAt", "updatedAt" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } }, "post": { "tags": [ "Clients" ], "summary": "Create a client", "description": "Email is required. A client already at this site with the same email, or the same phone and name, is refused with 409 DUPLICATE_CLIENT and the existing clientId. The response lists pendingAgreements the client must sign before a booking is accepted.\n\n**Required scope:** `clients:write`", "operationId": "post_clients", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "type": "string", "minLength": 1, "maxLength": 50 }, "lastName": { "type": "string", "minLength": 1, "maxLength": 50 }, "email": { "type": "string", "maxLength": 50, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "minLength": 1, "maxLength": 20 }, "dateOfBirth": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "sourceLabel": { "type": "string", "minLength": 1, "maxLength": 100 }, "communicationPreferences": { "type": "object", "properties": { "email": { "type": "boolean" }, "sms": { "type": "boolean" }, "phone": { "type": "boolean" } } } }, "required": [ "siteId", "firstName", "lastName", "email" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "client" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mobile": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fobNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dateOfBirth": { "description": "Returned only to a key that also holds clients:pii.", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "membershipStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "suspended": { "type": "boolean" }, "lastVisitAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "firstVisitAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "visitCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "joinedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "communicationPreferences": { "type": "object", "properties": { "email": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "sms": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "email", "sms", "phone" ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "HAPANA", "WEB", "APP", "STAFF", "KIOSK", "AGGREGATOR", "MIGRATION_IMPORTED", "APP_WEB_SIGNUP", "BUSINESS_ADDED", "EMBED_CREATED", "THIRD_PARTY", "CLIENT_REFERRAL", "SOCIAL_MEDIA" ] }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "pendingAgreements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "requiresSignature": { "type": "boolean" } }, "required": [ "id", "name", "type", "requiresSignature" ] } } }, "required": [ "object", "id", "siteId", "firstName", "lastName", "email", "mobile", "membershipStatus", "suspended", "lastVisitAt", "firstVisitAt", "visitCount", "joinedAt", "communicationPreferences", "source", "createdAt", "updatedAt", "pendingAgreements" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/clients/by-barcode": { "get": { "tags": [ "Clients" ], "summary": "Find a client by barcode", "description": "Finds the member at this site from a scanned card or app barcode.\n\n**Required scope:** `clients:read`", "operationId": "get_clients_by_barcode", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "barcode", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "client" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mobile": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fobNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dateOfBirth": { "description": "Returned only to a key that also holds clients:pii.", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "membershipStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "suspended": { "type": "boolean" }, "lastVisitAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "firstVisitAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "visitCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "joinedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "communicationPreferences": { "type": "object", "properties": { "email": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "sms": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "email", "sms", "phone" ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "HAPANA", "WEB", "APP", "STAFF", "KIOSK", "AGGREGATOR", "MIGRATION_IMPORTED", "APP_WEB_SIGNUP", "BUSINESS_ADDED", "EMBED_CREATED", "THIRD_PARTY", "CLIENT_REFERRAL", "SOCIAL_MEDIA" ] }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "siteId", "firstName", "lastName", "email", "mobile", "membershipStatus", "suspended", "lastVisitAt", "firstVisitAt", "visitCount", "joinedAt", "communicationPreferences", "source", "createdAt", "updatedAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/clients/{id}": { "get": { "tags": [ "Clients" ], "summary": "Retrieve a client", "description": "**Required scope:** `clients:read`", "operationId": "get_clients__id_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "client" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mobile": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fobNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dateOfBirth": { "description": "Returned only to a key that also holds clients:pii.", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "membershipStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "suspended": { "type": "boolean" }, "lastVisitAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "firstVisitAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "visitCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "joinedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "communicationPreferences": { "type": "object", "properties": { "email": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "sms": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "email", "sms", "phone" ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "HAPANA", "WEB", "APP", "STAFF", "KIOSK", "AGGREGATOR", "MIGRATION_IMPORTED", "APP_WEB_SIGNUP", "BUSINESS_ADDED", "EMBED_CREATED", "THIRD_PARTY", "CLIENT_REFERRAL", "SOCIAL_MEDIA" ] }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "siteId", "firstName", "lastName", "email", "mobile", "membershipStatus", "suspended", "lastVisitAt", "firstVisitAt", "visitCount", "joinedAt", "communicationPreferences", "source", "createdAt", "updatedAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } }, "post": { "tags": [ "Clients" ], "summary": "Update a client", "description": "Contact details and communication preferences. Set a channel to false to record an opt-out.\n\n**Required scope:** `clients:write`", "operationId": "post_clients__id_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 50 }, "lastName": { "type": "string", "minLength": 1, "maxLength": 50 }, "email": { "type": "string", "maxLength": 50, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "minLength": 1, "maxLength": 20 }, "dateOfBirth": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "fobNumber": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ] }, "communicationPreferences": { "type": "object", "properties": { "email": { "type": "boolean" }, "sms": { "type": "boolean" }, "phone": { "type": "boolean" } } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "client" }, "id": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mobile": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fobNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dateOfBirth": { "description": "Returned only to a key that also holds clients:pii.", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "membershipStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "suspended": { "type": "boolean" }, "lastVisitAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "firstVisitAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "visitCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "joinedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "communicationPreferences": { "type": "object", "properties": { "email": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "sms": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "email", "sms", "phone" ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "HAPANA", "WEB", "APP", "STAFF", "KIOSK", "AGGREGATOR", "MIGRATION_IMPORTED", "APP_WEB_SIGNUP", "BUSINESS_ADDED", "EMBED_CREATED", "THIRD_PARTY", "CLIENT_REFERRAL", "SOCIAL_MEDIA" ] }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "siteId", "firstName", "lastName", "email", "mobile", "membershipStatus", "suspended", "lastVisitAt", "firstVisitAt", "visitCount", "joinedAt", "communicationPreferences", "source", "createdAt", "updatedAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/clients/{id}/notes": { "post": { "tags": [ "Clients" ], "summary": "Add a note to a client", "description": "Records a call outcome or decline reason, visible to the studio team.\n\n**Required scope:** `clients:write`", "operationId": "post_clients__id__notes", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "content": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "siteId", "content" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "note" }, "id": { "type": "string" }, "clientId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "clientId", "createdAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/bookings": { "post": { "tags": [ "Bookings" ], "summary": "Book a client into a session", "description": "Books any client at the site, as the front desk would. Refusals carry a code: SESSION_FULL, NO_VALID_PACKAGE, ALREADY_BOOKED, BOOKING_OVERLAP, CLIENT_BLOCKED. No unpaid booking is ever created. Send an Idempotency-Key — a replay returns the original booking.\n\n**Required scope:** `bookings:write`", "operationId": "post_bookings", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sessionId": { "type": "string", "minLength": 1 }, "spotId": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "notes": { "type": "string", "maxLength": 1000 } }, "required": [ "siteId", "clientId", "sessionId" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "booking" }, "id": { "type": "string" }, "siteId": { "type": "string" }, "clientId": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "CONFIRMED", "DECLINED", "CANCELLED", "LATE_CANCELLED", "ATTENDED", "NO_SHOW", "INVITED", "EXPIRED", "REJECTED" ] }, "cancelled": { "type": "boolean" }, "paymentSource": { "anyOf": [ { "type": "string", "enum": [ "CREDIT", "FREE", "DROP_IN", "BILLING", "ADMIN", "AGGREGATOR", "IMPORT", "GUEST_PASS" ] }, { "type": "null" } ] }, "paymentStatus": { "anyOf": [ { "type": "string", "enum": [ "paid", "pending" ] }, { "type": "null" } ] }, "spotId": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "cancelledAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "session": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string", "enum": [ "CLASS", "PRIVATE", "WORKSHOP" ] }, "status": { "type": "string", "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED" ] }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localStartTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localEndTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "category", "status", "startTime", "endTime", "timezone", "localStartTime", "localEndTime" ] } }, "required": [ "object", "id", "siteId", "clientId", "status", "cancelled", "paymentSource", "paymentStatus", "spotId", "createdAt", "cancelledAt", "session" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } }, "get": { "tags": [ "Bookings" ], "summary": "List a client's bookings", "description": "startDate and endDate are inclusive calendar days at the site and bound when the session starts. A booking just created is visible here immediately.\n\n**Required scope:** `bookings:read`", "operationId": "get_bookings", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "format": "base64", "contentEncoding": "base64", "pattern": "^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "clientId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PENDING", "CONFIRMED", "DECLINED", "CANCELLED", "LATE_CANCELLED", "ATTENDED", "NO_SHOW", "INVITED", "EXPIRED", "REJECTED" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "booking" }, "id": { "type": "string" }, "siteId": { "type": "string" }, "clientId": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "CONFIRMED", "DECLINED", "CANCELLED", "LATE_CANCELLED", "ATTENDED", "NO_SHOW", "INVITED", "EXPIRED", "REJECTED" ] }, "cancelled": { "type": "boolean" }, "paymentSource": { "anyOf": [ { "type": "string", "enum": [ "CREDIT", "FREE", "DROP_IN", "BILLING", "ADMIN", "AGGREGATOR", "IMPORT", "GUEST_PASS" ] }, { "type": "null" } ] }, "paymentStatus": { "anyOf": [ { "type": "string", "enum": [ "paid", "pending" ] }, { "type": "null" } ] }, "spotId": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "cancelledAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "session": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string", "enum": [ "CLASS", "PRIVATE", "WORKSHOP" ] }, "status": { "type": "string", "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED" ] }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localStartTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localEndTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "category", "status", "startTime", "endTime", "timezone", "localStartTime", "localEndTime" ] } }, "required": [ "object", "id", "siteId", "clientId", "status", "cancelled", "paymentSource", "paymentStatus", "spotId", "createdAt", "cancelledAt", "session" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/bookings/{id}": { "get": { "tags": [ "Bookings" ], "summary": "Retrieve a booking", "description": "**Required scope:** `bookings:read`", "operationId": "get_bookings__id_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "booking" }, "id": { "type": "string" }, "siteId": { "type": "string" }, "clientId": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "CONFIRMED", "DECLINED", "CANCELLED", "LATE_CANCELLED", "ATTENDED", "NO_SHOW", "INVITED", "EXPIRED", "REJECTED" ] }, "cancelled": { "type": "boolean" }, "paymentSource": { "anyOf": [ { "type": "string", "enum": [ "CREDIT", "FREE", "DROP_IN", "BILLING", "ADMIN", "AGGREGATOR", "IMPORT", "GUEST_PASS" ] }, { "type": "null" } ] }, "paymentStatus": { "anyOf": [ { "type": "string", "enum": [ "paid", "pending" ] }, { "type": "null" } ] }, "spotId": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "cancelledAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "session": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string", "enum": [ "CLASS", "PRIVATE", "WORKSHOP" ] }, "status": { "type": "string", "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED" ] }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localStartTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localEndTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "category", "status", "startTime", "endTime", "timezone", "localStartTime", "localEndTime" ] } }, "required": [ "object", "id", "siteId", "clientId", "status", "cancelled", "paymentSource", "paymentStatus", "spotId", "createdAt", "cancelledAt", "session" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/bookings/{id}/cancellation": { "get": { "tags": [ "Bookings" ], "summary": "Preview what cancelling would cost", "description": "Whether a cancellation now is late, until when it is free, the credits that would be forfeited and any late-cancel fee. Nothing is changed.\n\n**Required scope:** `bookings:read`", "operationId": "get_bookings__id__cancellation", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "cancellation_preview" }, "bookingId": { "type": "string" }, "lateCancel": { "type": "boolean" }, "cancellableUntil": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "creditsForfeited": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "lateCancelFee": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "object", "bookingId", "lateCancel", "cancellableUntil", "creditsForfeited", "lateCancelFee" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/bookings/{id}/cancel": { "post": { "tags": [ "Bookings" ], "summary": "Cancel a booking", "description": "Inside the late-cancel window the booking becomes LATE_CANCELLED and the site policy applies. A paid drop-in is refunded to account credit, never to the card.\n\n**Required scope:** `bookings:write`", "operationId": "post_bookings__id__cancel", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "siteId" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "booking" }, "id": { "type": "string" }, "siteId": { "type": "string" }, "clientId": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "CONFIRMED", "DECLINED", "CANCELLED", "LATE_CANCELLED", "ATTENDED", "NO_SHOW", "INVITED", "EXPIRED", "REJECTED" ] }, "cancelled": { "type": "boolean" }, "paymentSource": { "anyOf": [ { "type": "string", "enum": [ "CREDIT", "FREE", "DROP_IN", "BILLING", "ADMIN", "AGGREGATOR", "IMPORT", "GUEST_PASS" ] }, { "type": "null" } ] }, "paymentStatus": { "anyOf": [ { "type": "string", "enum": [ "paid", "pending" ] }, { "type": "null" } ] }, "spotId": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "cancelledAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "session": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string", "enum": [ "CLASS", "PRIVATE", "WORKSHOP" ] }, "status": { "type": "string", "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED" ] }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localStartTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localEndTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "category", "status", "startTime", "endTime", "timezone", "localStartTime", "localEndTime" ] } }, "required": [ "object", "id", "siteId", "clientId", "status", "cancelled", "paymentSource", "paymentStatus", "spotId", "createdAt", "cancelledAt", "session" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/sessions/{id}/waitlist": { "post": { "tags": [ "Bookings" ], "summary": "Join a session's waitlist", "description": "Refused with WAITLIST_NOT_ENABLED, WAITLIST_FULL, WAITLIST_LOCKED, ALREADY_ON_WAITLIST, ALREADY_BOOKED or SPOT_AVAILABLE (waitlist strategy ALL with a spot open: book it instead). Accepts any session id GET /sessions returns.\n\n**Required scope:** `bookings:write`", "operationId": "post_sessions__id__waitlist", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "siteId", "clientId" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "waitlist_entry" }, "id": { "type": "string" }, "sessionId": { "type": "string" }, "clientId": { "type": "string" }, "position": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "WAITING", "INVITED", "CONVERTED", "EXPIRED", "CANCELLED" ] } }, "required": [ "object", "id", "sessionId", "clientId", "position", "status" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/sessions/{id}/waitlist/{clientId}/leave": { "post": { "tags": [ "Bookings" ], "summary": "Leave a waitlist", "description": "Answers 204 whether or not the client was on it, so a retry is safe.\n\n**Required scope:** `bookings:write`", "operationId": "post_sessions__id__waitlist__clientId__leave", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "responses": { "204": { "description": "No content" }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/bookings/{id}/check-in": { "post": { "tags": [ "Bookings" ], "summary": "Mark a booking as attended", "description": "Records attendance after the class has run, exactly as the front desk would, so visit history and credit consumption stay consistent.\n\n**Required scope:** `bookings:write`", "operationId": "post_bookings__id__check_in", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "siteId" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "booking" }, "id": { "type": "string" }, "siteId": { "type": "string" }, "clientId": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "CONFIRMED", "DECLINED", "CANCELLED", "LATE_CANCELLED", "ATTENDED", "NO_SHOW", "INVITED", "EXPIRED", "REJECTED" ] }, "cancelled": { "type": "boolean" }, "paymentSource": { "anyOf": [ { "type": "string", "enum": [ "CREDIT", "FREE", "DROP_IN", "BILLING", "ADMIN", "AGGREGATOR", "IMPORT", "GUEST_PASS" ] }, { "type": "null" } ] }, "paymentStatus": { "anyOf": [ { "type": "string", "enum": [ "paid", "pending" ] }, { "type": "null" } ] }, "spotId": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "cancelledAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "session": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string", "enum": [ "CLASS", "PRIVATE", "WORKSHOP" ] }, "status": { "type": "string", "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED" ] }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localStartTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localEndTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "category", "status", "startTime", "endTime", "timezone", "localStartTime", "localEndTime" ] } }, "required": [ "object", "id", "siteId", "clientId", "status", "cancelled", "paymentSource", "paymentStatus", "spotId", "createdAt", "cancelledAt", "session" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/bookings/{id}/no-show": { "post": { "tags": [ "Bookings" ], "summary": "Mark a booking as a no-show", "description": "A no-show is a retention signal, not a dead end: the site may charge its configured no-show fee, and the booking stays on the member’s history.\n\n**Required scope:** `bookings:write`", "operationId": "post_bookings__id__no_show", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "siteId" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "booking" }, "id": { "type": "string" }, "siteId": { "type": "string" }, "clientId": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "CONFIRMED", "DECLINED", "CANCELLED", "LATE_CANCELLED", "ATTENDED", "NO_SHOW", "INVITED", "EXPIRED", "REJECTED" ] }, "cancelled": { "type": "boolean" }, "paymentSource": { "anyOf": [ { "type": "string", "enum": [ "CREDIT", "FREE", "DROP_IN", "BILLING", "ADMIN", "AGGREGATOR", "IMPORT", "GUEST_PASS" ] }, { "type": "null" } ] }, "paymentStatus": { "anyOf": [ { "type": "string", "enum": [ "paid", "pending" ] }, { "type": "null" } ] }, "spotId": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "cancelledAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "session": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string", "enum": [ "CLASS", "PRIVATE", "WORKSHOP" ] }, "status": { "type": "string", "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED" ] }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localStartTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localEndTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "category", "status", "startTime", "endTime", "timezone", "localStartTime", "localEndTime" ] } }, "required": [ "object", "id", "siteId", "clientId", "status", "cancelled", "paymentSource", "paymentStatus", "spotId", "createdAt", "cancelledAt", "session" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/checkins": { "get": { "tags": [ "Check-ins" ], "summary": "List check-ins", "description": "The visit feed for a site. A refused entry is recorded too, with status FAIL and the reason, which is what makes the feed usable for support.\n\n**Required scope:** `checkins:read`", "operationId": "get_checkins", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "format": "base64", "contentEncoding": "base64", "pattern": "^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "clientId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SESSION", "GENERAL", "TANNING", "ZONE" ] } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SUCCESS", "FAIL", "UNKNOWN" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "checkin" }, "id": { "type": "string" }, "siteId": { "type": "string" }, "clientId": { "type": "string" }, "type": { "type": "string", "enum": [ "SESSION", "GENERAL", "TANNING", "ZONE" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "UNKNOWN" ] }, "source": { "type": "string", "enum": [ "BARCODE_SCAN", "BARCODE_DEVICE_SCAN", "FOB_DEVICE_SCAN", "CONTACTLESS", "FOB_SCAN", "IN_APP", "KIOSK", "PUBLIC_API", "QR_CODE", "WIDGET", "CORE", "IMPORT", "AGGREGATOR" ] }, "failReason": { "anyOf": [ { "type": "string", "enum": [ "FAILED_PAYMENTS", "NO_VALID_MEMBERSHIP_OR_BOOKING", "BOOKING_PAYMENT_PENDING", "SUSPENDED", "NO_ACTIVE_PACKAGE", "MEMBERSHIP_ON_HOLD", "NO_CREDITS", "NOT_IN_TIME", "QUESTIONNAIRE_FAILED", "CHECK_IN_WINDOW_EXPIRED", "AGGREGATOR_DECLINED", "AGGREGATOR_VALIDATION_REQUIRED" ] }, { "type": "null" } ] }, "sessionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bookingId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "checkedInAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localCheckedInAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "object", "id", "siteId", "clientId", "type", "status", "source", "failReason", "sessionId", "bookingId", "checkedInAt", "timezone", "localCheckedInAt" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } }, "post": { "tags": [ "Check-ins" ], "summary": "Record a walk-in check-in", "description": "For a visit with no booking. A member who may not enter is recorded with status FAIL and a failReason rather than the request failing. Check a booked class in through POST /bookings/{id}/check-in instead, so the class roster stays in step.\n\n**Required scope:** `checkins:write`", "operationId": "post_checkins", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "siteId", "clientId" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "checkin" }, "id": { "type": "string" }, "siteId": { "type": "string" }, "clientId": { "type": "string" }, "type": { "type": "string", "enum": [ "SESSION", "GENERAL", "TANNING", "ZONE" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "UNKNOWN" ] }, "source": { "type": "string", "enum": [ "BARCODE_SCAN", "BARCODE_DEVICE_SCAN", "FOB_DEVICE_SCAN", "CONTACTLESS", "FOB_SCAN", "IN_APP", "KIOSK", "PUBLIC_API", "QR_CODE", "WIDGET", "CORE", "IMPORT", "AGGREGATOR" ] }, "failReason": { "anyOf": [ { "type": "string", "enum": [ "FAILED_PAYMENTS", "NO_VALID_MEMBERSHIP_OR_BOOKING", "BOOKING_PAYMENT_PENDING", "SUSPENDED", "NO_ACTIVE_PACKAGE", "MEMBERSHIP_ON_HOLD", "NO_CREDITS", "NOT_IN_TIME", "QUESTIONNAIRE_FAILED", "CHECK_IN_WINDOW_EXPIRED", "AGGREGATOR_DECLINED", "AGGREGATOR_VALIDATION_REQUIRED" ] }, { "type": "null" } ] }, "sessionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bookingId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "checkedInAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localCheckedInAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "object", "id", "siteId", "clientId", "type", "status", "source", "failReason", "sessionId", "bookingId", "checkedInAt", "timezone", "localCheckedInAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/checkins/{id}": { "get": { "tags": [ "Check-ins" ], "summary": "Retrieve a check-in", "description": "**Required scope:** `checkins:read`", "operationId": "get_checkins__id_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "checkin" }, "id": { "type": "string" }, "siteId": { "type": "string" }, "clientId": { "type": "string" }, "type": { "type": "string", "enum": [ "SESSION", "GENERAL", "TANNING", "ZONE" ] }, "status": { "type": "string", "enum": [ "SUCCESS", "FAIL", "UNKNOWN" ] }, "source": { "type": "string", "enum": [ "BARCODE_SCAN", "BARCODE_DEVICE_SCAN", "FOB_DEVICE_SCAN", "CONTACTLESS", "FOB_SCAN", "IN_APP", "KIOSK", "PUBLIC_API", "QR_CODE", "WIDGET", "CORE", "IMPORT", "AGGREGATOR" ] }, "failReason": { "anyOf": [ { "type": "string", "enum": [ "FAILED_PAYMENTS", "NO_VALID_MEMBERSHIP_OR_BOOKING", "BOOKING_PAYMENT_PENDING", "SUSPENDED", "NO_ACTIVE_PACKAGE", "MEMBERSHIP_ON_HOLD", "NO_CREDITS", "NOT_IN_TIME", "QUESTIONNAIRE_FAILED", "CHECK_IN_WINDOW_EXPIRED", "AGGREGATOR_DECLINED", "AGGREGATOR_VALIDATION_REQUIRED" ] }, { "type": "null" } ] }, "sessionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bookingId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "checkedInAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "localCheckedInAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "object", "id", "siteId", "clientId", "type", "status", "source", "failReason", "sessionId", "bookingId", "checkedInAt", "timezone", "localCheckedInAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/clients/{id}/packages": { "get": { "tags": [ "Client packages" ], "summary": "List the packages a client owns", "description": "What this member has bought, as distinct from what the site sells (GET /packages). Omit siteId to read every package the member holds across the brand in one call; each package names the site that owns it. accessSiteIds lists every site the package can be used at, home site included — the same rule booking and door access apply.\n\n**Required scope:** `packages:read`", "operationId": "get_clients__id__packages", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "format": "base64", "contentEncoding": "base64", "pattern": "^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "siteId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ACTIVE", "SUSPENDED", "EXPIRED", "CANCELED", "COMPLETED", "PENDING_START_DATE" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "client_package" }, "id": { "type": "string" }, "clientId": { "type": "string" }, "siteId": { "type": "string" }, "accessSiteIds": { "type": "array", "items": { "type": "string" } }, "packageId": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "PACKAGE", "MEMBERSHIP", "GUEST_PASS", "ADD_ON" ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "ACTIVE", "SUSPENDED", "EXPIRED", "CANCELED", "COMPLETED", "PENDING_START_DATE" ] }, "onHold": { "type": "boolean" }, "autoRenew": { "type": "boolean" }, "purchasedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "startsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextBillingDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cancelledAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "object", "id", "clientId", "siteId", "accessSiteIds", "packageId", "name", "type", "status", "onHold", "autoRenew", "purchasedAt", "startsAt", "expiresAt", "nextBillingDate", "price", "currency", "cancelledAt" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/clients/{id}/packages/{packageId}": { "get": { "tags": [ "Client packages" ], "summary": "Retrieve a package a client owns", "description": "**Required scope:** `packages:read`", "operationId": "get_clients__id__packages__packageId_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "packageId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "client_package" }, "id": { "type": "string" }, "clientId": { "type": "string" }, "siteId": { "type": "string" }, "accessSiteIds": { "type": "array", "items": { "type": "string" } }, "packageId": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "PACKAGE", "MEMBERSHIP", "GUEST_PASS", "ADD_ON" ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "ACTIVE", "SUSPENDED", "EXPIRED", "CANCELED", "COMPLETED", "PENDING_START_DATE" ] }, "onHold": { "type": "boolean" }, "autoRenew": { "type": "boolean" }, "purchasedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "startsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextBillingDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cancelledAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "object", "id", "clientId", "siteId", "accessSiteIds", "packageId", "name", "type", "status", "onHold", "autoRenew", "purchasedAt", "startsAt", "expiresAt", "nextBillingDate", "price", "currency", "cancelledAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/clients/{id}/packages/{packageId}/suspend": { "post": { "tags": [ "Client packages" ], "summary": "Suspend a membership", "description": "Omitting endDate pauses indefinitely. Resuming shifts the remaining billing dates forward by the paused span, so the member is never billed for time they did not have.\n\n**Required scope:** `packages:write`", "operationId": "post_clients__id__packages__packageId__suspend", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "packageId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "startDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "endDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "reason": { "type": "string", "maxLength": 500 } }, "required": [ "siteId" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "client_package" }, "id": { "type": "string" }, "clientId": { "type": "string" }, "siteId": { "type": "string" }, "accessSiteIds": { "type": "array", "items": { "type": "string" } }, "packageId": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "PACKAGE", "MEMBERSHIP", "GUEST_PASS", "ADD_ON" ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "ACTIVE", "SUSPENDED", "EXPIRED", "CANCELED", "COMPLETED", "PENDING_START_DATE" ] }, "onHold": { "type": "boolean" }, "autoRenew": { "type": "boolean" }, "purchasedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "startsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextBillingDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cancelledAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "object", "id", "clientId", "siteId", "accessSiteIds", "packageId", "name", "type", "status", "onHold", "autoRenew", "purchasedAt", "startsAt", "expiresAt", "nextBillingDate", "price", "currency", "cancelledAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/clients/{id}/packages/{packageId}/resume": { "post": { "tags": [ "Client packages" ], "summary": "Resume a suspended membership", "description": "**Required scope:** `packages:write`", "operationId": "post_clients__id__packages__packageId__resume", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "packageId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "restartDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, "required": [ "siteId" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "client_package" }, "id": { "type": "string" }, "clientId": { "type": "string" }, "siteId": { "type": "string" }, "accessSiteIds": { "type": "array", "items": { "type": "string" } }, "packageId": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "PACKAGE", "MEMBERSHIP", "GUEST_PASS", "ADD_ON" ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "ACTIVE", "SUSPENDED", "EXPIRED", "CANCELED", "COMPLETED", "PENDING_START_DATE" ] }, "onHold": { "type": "boolean" }, "autoRenew": { "type": "boolean" }, "purchasedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "startsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextBillingDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cancelledAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "object", "id", "clientId", "siteId", "accessSiteIds", "packageId", "name", "type", "status", "onHold", "autoRenew", "purchasedAt", "startsAt", "expiresAt", "nextBillingDate", "price", "currency", "cancelledAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/clients/{id}/packages/{packageId}/cancel": { "post": { "tags": [ "Client packages" ], "summary": "Cancel a package or membership", "description": "Honours the template’s minimum term and any cancellation charge. A future cancelAt schedules the cancellation instead of applying it now.\n\n**Required scope:** `packages:write`", "operationId": "post_clients__id__packages__packageId__cancel", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "packageId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reason": { "type": "string", "maxLength": 500 }, "cancelAt": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, "required": [ "siteId" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "client_package" }, "id": { "type": "string" }, "clientId": { "type": "string" }, "siteId": { "type": "string" }, "accessSiteIds": { "type": "array", "items": { "type": "string" } }, "packageId": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "PACKAGE", "MEMBERSHIP", "GUEST_PASS", "ADD_ON" ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "ACTIVE", "SUSPENDED", "EXPIRED", "CANCELED", "COMPLETED", "PENDING_START_DATE" ] }, "onHold": { "type": "boolean" }, "autoRenew": { "type": "boolean" }, "purchasedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "startsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextBillingDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cancelledAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "object", "id", "clientId", "siteId", "accessSiteIds", "packageId", "name", "type", "status", "onHold", "autoRenew", "purchasedAt", "startsAt", "expiresAt", "nextBillingDate", "price", "currency", "cancelledAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/payments": { "get": { "tags": [ "Payments" ], "summary": "List payments", "description": "Read only, for reconciliation. Card details, stored payment methods, payment processor identifiers and fee splits are never included.\n\n**Required scope:** `payments:read`", "operationId": "get_payments", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "format": "base64", "contentEncoding": "base64", "pattern": "^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "clientId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pending", "processing", "success", "failed", "partially_refunded", "refunded", "canceled" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "payment" }, "id": { "type": "string" }, "siteId": { "type": "string" }, "clientId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "invoiceId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "processing", "success", "failed", "partially_refunded", "refunded", "canceled" ] }, "method": { "type": "string", "enum": [ "card", "bank", "terminal", "cash", "account_credit", "custom" ] }, "currency": { "type": "string" }, "amount": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "siteId", "clientId", "invoiceId", "status", "method", "currency", "amount", "createdAt" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/payments/{id}": { "get": { "tags": [ "Payments" ], "summary": "Retrieve a payment", "description": "**Required scope:** `payments:read`", "operationId": "get_payments__id_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "payment" }, "id": { "type": "string" }, "siteId": { "type": "string" }, "clientId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "invoiceId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "processing", "success", "failed", "partially_refunded", "refunded", "canceled" ] }, "method": { "type": "string", "enum": [ "card", "bank", "terminal", "cash", "account_credit", "custom" ] }, "currency": { "type": "string" }, "amount": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "id", "siteId", "clientId", "invoiceId", "status", "method", "currency", "amount", "createdAt" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/reports": { "get": { "tags": [ "Reports" ], "summary": "List available reports", "description": "Only the reports this API key is allowed to run.\n\n**Required scope:** `reports:read`", "operationId": "get_reports", "security": [ { "partnerKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "report" }, "name": { "type": "string", "enum": [ "all_clients", "client_checkin", "late_cancels", "no_shows", "first_visits", "clients_absent", "session_credits_remaining", "membership_details", "revenue_used", "net_revenue", "sales_by_service", "presold_services", "failed_payments", "failed_payment_history", "suspended_memberships", "stripe_settlement", "cancellation_report", "projected_revenue", "missing_payment_methods", "royalty_fee_distribution", "referrals", "birthdays", "session_feedback", "member_movement", "member_movement_transfers", "member_movement_transfer_summary", "new_clients", "income_handover", "delinquency", "all_invoices", "discount_usage", "memberships_expiring", "pos_history", "promo_code_usage", "expired_session_credits", "stripe_card_updater", "account_credit_balance", "ezypay_settlement", "gift_cards", "current_inventory", "refund_history", "unpaid_sessions", "amount_due", "intro_offer_conversions", "staff_utilisation", "client_lifetime_value", "client_retention_rate", "payroll", "payroll_tier_audit", "one_to_one_sessions", "session_performance", "tax_summary", "revenue_leakage", "waitlist", "client_engagement", "multi_location_comparison", "contract_agreement", "write_off_bad_debt", "content_engagement", "challenge_participation", "challenge_enrollment_detail", "challenges", "challenge_performance", "challenge_member_consolidated", "challenge_member_daily", "metric_tracking", "member_metric_detail", "leaderboard_history", "awards_summary", "video_performance", "banner_clicks", "theme_subscription_usage", "content_library_statement", "content_library_member_usage", "content_library_title_usage", "content_library_usage_detail", "content_library_usage_by_corporate", "content_library_billing_evidence", "equipment_usage", "client_equipment_usage", "upgrade_downgrade_report", "add_ons_report", "add_on_memberships", "cash_drawer", "monthly_billing_statement", "drdr_report", "guest_pass", "member_status_summary", "attendance_by_session", "commission_summary", "commission_detail", "commission_events", "staff_earnings" ] }, "label": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string", "enum": [ "client_and_attendance", "financial", "staff", "content", "commissions" ] }, "requiresDateRange": { "type": "boolean" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" } }, "required": [ "key", "label", "type" ] } } }, "required": [ "object", "name", "label", "description", "category", "requiresDateRange", "columns" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/reports/run": { "post": { "tags": [ "Reports" ], "summary": "Run a report", "description": "Uses POST because the filters are structured; nothing is created. Results are paginated with a cursor. For large results, start an export instead.\n\n**Required scope:** `reports:read`", "operationId": "post_reports_run", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reportName": { "type": "string", "enum": [ "all_clients", "client_checkin", "late_cancels", "no_shows", "first_visits", "clients_absent", "session_credits_remaining", "membership_details", "revenue_used", "net_revenue", "sales_by_service", "presold_services", "failed_payments", "failed_payment_history", "suspended_memberships", "stripe_settlement", "cancellation_report", "projected_revenue", "missing_payment_methods", "royalty_fee_distribution", "referrals", "birthdays", "session_feedback", "member_movement", "member_movement_transfers", "member_movement_transfer_summary", "new_clients", "income_handover", "delinquency", "all_invoices", "discount_usage", "memberships_expiring", "pos_history", "promo_code_usage", "expired_session_credits", "stripe_card_updater", "account_credit_balance", "ezypay_settlement", "gift_cards", "current_inventory", "refund_history", "unpaid_sessions", "amount_due", "intro_offer_conversions", "staff_utilisation", "client_lifetime_value", "client_retention_rate", "payroll", "payroll_tier_audit", "one_to_one_sessions", "session_performance", "tax_summary", "revenue_leakage", "waitlist", "client_engagement", "multi_location_comparison", "contract_agreement", "write_off_bad_debt", "content_engagement", "challenge_participation", "challenge_enrollment_detail", "challenges", "challenge_performance", "challenge_member_consolidated", "challenge_member_daily", "metric_tracking", "member_metric_detail", "leaderboard_history", "awards_summary", "video_performance", "banner_clicks", "theme_subscription_usage", "content_library_statement", "content_library_member_usage", "content_library_title_usage", "content_library_usage_detail", "content_library_usage_by_corporate", "content_library_billing_evidence", "equipment_usage", "client_equipment_usage", "upgrade_downgrade_report", "add_ons_report", "add_on_memberships", "cash_drawer", "monthly_billing_statement", "drdr_report", "guest_pass", "member_status_summary", "attendance_by_session", "commission_summary", "commission_detail", "commission_events", "staff_earnings" ] }, "siteIds": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "dateFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "dateTo": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "columns": { "type": "array", "items": { "type": "string" } }, "filters": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "cursor": { "type": "string" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 } }, "required": [ "reportName", "siteIds" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "report_result" }, "reportName": { "type": "string" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" } }, "required": [ "key", "label", "type" ] } }, "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "hasMore": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "object", "reportName", "columns", "data", "hasMore", "nextCursor" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/reports/exports": { "post": { "tags": [ "Reports" ], "summary": "Start a CSV export", "description": "Returns a jobId to poll, because a large export takes longer than one request.\n\n**Required scope:** `reports:read`", "operationId": "post_reports_exports", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reportName": { "type": "string", "enum": [ "all_clients", "client_checkin", "late_cancels", "no_shows", "first_visits", "clients_absent", "session_credits_remaining", "membership_details", "revenue_used", "net_revenue", "sales_by_service", "presold_services", "failed_payments", "failed_payment_history", "suspended_memberships", "stripe_settlement", "cancellation_report", "projected_revenue", "missing_payment_methods", "royalty_fee_distribution", "referrals", "birthdays", "session_feedback", "member_movement", "member_movement_transfers", "member_movement_transfer_summary", "new_clients", "income_handover", "delinquency", "all_invoices", "discount_usage", "memberships_expiring", "pos_history", "promo_code_usage", "expired_session_credits", "stripe_card_updater", "account_credit_balance", "ezypay_settlement", "gift_cards", "current_inventory", "refund_history", "unpaid_sessions", "amount_due", "intro_offer_conversions", "staff_utilisation", "client_lifetime_value", "client_retention_rate", "payroll", "payroll_tier_audit", "one_to_one_sessions", "session_performance", "tax_summary", "revenue_leakage", "waitlist", "client_engagement", "multi_location_comparison", "contract_agreement", "write_off_bad_debt", "content_engagement", "challenge_participation", "challenge_enrollment_detail", "challenges", "challenge_performance", "challenge_member_consolidated", "challenge_member_daily", "metric_tracking", "member_metric_detail", "leaderboard_history", "awards_summary", "video_performance", "banner_clicks", "theme_subscription_usage", "content_library_statement", "content_library_member_usage", "content_library_title_usage", "content_library_usage_detail", "content_library_usage_by_corporate", "content_library_billing_evidence", "equipment_usage", "client_equipment_usage", "upgrade_downgrade_report", "add_ons_report", "add_on_memberships", "cash_drawer", "monthly_billing_statement", "drdr_report", "guest_pass", "member_status_summary", "attendance_by_session", "commission_summary", "commission_detail", "commission_events", "staff_earnings" ] }, "siteIds": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "dateFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "dateTo": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "columns": { "type": "array", "items": { "type": "string" } }, "filters": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "reportName", "siteIds" ] } } } }, "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "report_export" }, "jobId": { "type": "string" }, "totalRows": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "object", "jobId", "totalRows" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/reports/exports/{jobId}": { "get": { "tags": [ "Reports" ], "summary": "Poll an export job", "description": "Once complete, carries a short-lived download URL.\n\n**Required scope:** `reports:read`", "operationId": "get_reports_exports__jobId_", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "report_export_status" }, "jobId": { "type": "string" }, "status": { "type": "string", "enum": [ "running", "completed", "failed" ] }, "rowsProcessed": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalRows": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "downloadUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "object", "jobId", "status", "rowsProcessed", "totalRows", "downloadUrl", "expiresAt", "error" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/packages": { "get": { "tags": [ "Packages" ], "summary": "List packages and memberships", "description": "Active packages a site sells, with price as a decimal string. Read only.\n\n**Required scope:** `packages:read`", "operationId": "get_packages", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PACKAGE", "MEMBERSHIP", "GUEST_PASS", "ADD_ON" ] } }, { "name": "introOffer", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "package" }, "id": { "type": "string" }, "siteId": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "PACKAGE", "MEMBERSHIP", "GUEST_PASS", "ADD_ON" ] }, "price": { "type": "string" }, "introOffer": { "type": "boolean" }, "availableOnline": { "type": "boolean" }, "length": { "anyOf": [ { "type": "object", "properties": { "amount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "unit": { "type": "string", "enum": [ "YEARS", "MONTHS", "WEEKS", "DAYS" ] } }, "required": [ "amount", "unit" ] }, { "type": "null" } ] }, "billingCycle": { "anyOf": [ { "type": "object", "properties": { "amount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "unit": { "type": "string", "enum": [ "YEARS", "MONTHS", "WEEKS" ] } }, "required": [ "amount", "unit" ] }, { "type": "null" } ] }, "credits": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "UNLIMITED", "LIMITED" ] }, "amount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "sessionTypeIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "amount", "sessionTypeIds" ] } } }, "required": [ "object", "id", "siteId", "name", "description", "type", "price", "introOffer", "availableOnline", "length", "billingCycle", "credits" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/staff-access-policies": { "get": { "tags": [ "Reference" ], "summary": "List assignable access policies", "description": "Id and name only. Lists the policies this API key is allowed to assign.\n\n**Required scope:** `staff:read`", "operationId": "get_staff_access_policies", "security": [ { "partnerKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "staff_access_policy" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "object", "id", "name" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/locations": { "get": { "tags": [ "Reference" ], "summary": "List locations within a site", "description": "**Required scope:** `sites:read`", "operationId": "get_locations", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "location" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDefault": { "type": "boolean" } }, "required": [ "object", "id", "siteId", "name", "type", "isDefault" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/business/access/checkin-eligibility": { "get": { "tags": [ "Door access" ], "summary": "List check-in eligibility", "description": "Whether each member at a site may check in right now, for a door system to cache. Without `updatedSince` it returns every member with a verdict; with it, only the verdicts that changed since then. Denied members are rows too, so a member missing from the list has no verdict yet; never treat that as eligible. Follow `nextCursor` while `hasMore` is true; a page can hold fewer than `limit` entries. When your door system has no active door registered at the site, the request is refused with 403 and `code: PROVIDER_NOT_ACTIVE_AT_SITE`; stop pulling that site until a door is registered.\n\n**Required scope:** `access:read`", "operationId": "get_business_access_checkin_eligibility", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "updatedSince", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "format": "base64", "contentEncoding": "base64", "pattern": "^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 100, "type": "integer", "minimum": 1, "maximum": 500 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "checkin_eligibility" }, "memberId": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "credentials": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "BARCODE" ] }, "value": { "type": "string" } }, "required": [ "type", "value" ] } }, "canCheckIn": { "type": "boolean" }, "reason": { "type": "string", "enum": [ "OK", "NO_CREDITS", "CHECKIN_DISABLED", "PAYMENT_FAIL", "SUSPENDED", "MEMBER_BLOCKED", "NO_ACTIVE_MEMBERSHIP", "ACCESS_HOURS", "ZONE_SCHEDULE", "ACCESS_DENIED", "DOOR_NOT_ACTIVE" ] }, "doors": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "canCheckIn": { "type": "boolean" }, "reason": { "type": "string", "enum": [ "OK", "NO_CREDITS", "CHECKIN_DISABLED", "PAYMENT_FAIL", "SUSPENDED", "MEMBER_BLOCKED", "NO_ACTIVE_MEMBERSHIP", "ACCESS_HOURS", "ZONE_SCHEDULE", "ACCESS_DENIED", "DOOR_NOT_ACTIVE" ] } }, "required": [ "canCheckIn", "reason" ] } }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "memberId", "barcode", "credentials", "canCheckIn", "reason", "doors", "updatedAt" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope (`code: INSUFFICIENT_SCOPE`), or the site has no active door registered for partner access (`code: PROVIDER_NOT_ACTIVE_AT_SITE`)", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/business/access/doors": { "get": { "tags": [ "Door access" ], "summary": "List doors at a site", "description": "The door-access partner doors at a site, with the `doorId` to send on each tap and to read from the eligibility feed's `doors` map. Map each one to your own device. Inactive doors stay listed with `status: INACTIVE`; removed doors do not appear. A site with no partner door returns an empty list. The list is not paginated. Until door listing is switched on for your account the call answers 404 with `code: FEATURE_NOT_ENABLED`.\n\n**Required scope:** `access:read`", "operationId": "get_business_access_doors", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "door" }, "doorId": { "type": "string" }, "siteId": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "isMainEntrance": { "type": "boolean" }, "zone": { "anyOf": [ { "type": "object", "properties": { "zoneId": { "type": "string" }, "name": { "type": "string" }, "entryMode": { "type": "string", "enum": [ "ACCESS_ONLY", "CHECK_IN" ] }, "walkIn": { "type": "string", "enum": [ "ALLOWED", "BOOKING_ONLY" ] }, "accessSchedule": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "TWENTY_FOUR_HOUR", "BUSINESS_HOURS", "CUSTOM" ] } }, "required": [ "mode" ] }, { "type": "null" } ] }, "sessionTypeIds": { "type": "array", "items": { "type": "string" } }, "rooms": { "type": "array", "items": { "type": "object", "properties": { "siteLocationId": { "type": "string" }, "siteLocationRoomId": { "type": "string" } }, "required": [ "siteLocationId", "siteLocationRoomId" ] } } }, "required": [ "zoneId", "name", "entryMode", "walkIn", "accessSchedule", "sessionTypeIds", "rooms" ] }, { "type": "null" } ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "doorId", "siteId", "name", "status", "isMainEntrance", "zone", "updatedAt" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "object", "data", "hasMore", "url" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/public-api/v2/business/access/checkin": { "post": { "tags": [ "Door access" ], "summary": "Check a member in at a door", "description": "Call on every tap. Hapana decides whether the member may enter and, if so, records the check-in and uses a credit when the membership needs one. A refusal is still a 200, with `canCheckIn: false` and a `reason`. A tap at a site where your door system has no active door, or naming a `doorId` that is not one of your active doors, is refused with `reason: DOOR_NOT_ACTIVE` and nothing is recorded. Send `barcode` or `memberId`. Send `occurredAt` when replaying a tap your door decided offline; it may be at most 5 minutes in the future and 7 days in the past, otherwise the tap is refused with 422.\n\n**Required scope:** `access:write`", "operationId": "post_business_access_checkin", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Makes the request safe to retry. A retry with the same key returns the first response; reusing a key with a different body is refused with 422." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "barcode": { "type": "string", "minLength": 1 }, "memberId": { "type": "string", "minLength": 1 }, "doorId": { "type": "string", "minLength": 1 }, "occurredAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "doorDecision": { "type": "string", "enum": [ "ALLOW", "DENY" ] }, "doorDecisionReason": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "siteId" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "const": "checkin_result" }, "canCheckIn": { "type": "boolean" }, "reason": { "type": "string", "enum": [ "OK", "NO_CREDITS", "CHECKIN_DISABLED", "PAYMENT_FAIL", "SUSPENDED", "MEMBER_BLOCKED", "NO_ACTIVE_MEMBERSHIP", "ACCESS_HOURS", "ZONE_SCHEDULE", "ACCESS_DENIED", "DOOR_NOT_ACTIVE" ] }, "checkInId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "creditsRemaining": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "creditsAtRenewal": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "renewalAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "isUnlimited": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "object", "canCheckIn", "reason", "checkInId", "timestamp", "creditsRemaining", "creditsAtRenewal", "renewalAt", "isUnlimited" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "409": { "description": "A request with this Idempotency-Key is still being processed" }, "422": { "description": "Idempotency-Key reused with a different request body" } } } }, "/public-api/v2/business/access/bookings": { "get": { "tags": [ "Door access" ], "summary": "List upcoming bookings for door pre-loading", "description": "One row per booking for the sessions starting in `[from, from + days)` at a site, with the session embedded and the `entryWindow` the door will honour, so a panel can hold a member before class. `from` defaults to two hours before now, so a class in progress is still served, and may be at most 7 days back; `days` defaults to 7 (max 14). Live rows are `CONFIRMED` or `ATTENDED`; a cancelled booking, late cancel, cancelled class or deleted class all come back as `CANCELLED`, which removes the pre-load. With `changedSince` only rows whose booking or session changed after it are returned; echo the response `serverTime` minus five minutes as the next `changedSince` and upsert by `bookingId`, since rows across the overlap repeat. Do a full pull without `changedSince` once a day and treat it as the complete set for the window: a booking absent from it has left the feed (moved out of the window, or no longer CONFIRMED or ATTENDED) and should be dropped. A cursor pins the window and the `serverTime` of the walk it was issued for: later pages ignore `from`, `days` and `changedSince` and return the first page `serverTime`, so use that value for the next delta even if the walk paused. A cursor older than a day or outside the feed limits is a 400; start a new walk. Check-in setting changes return the whole window on the next delta, and an ATTENDED row carries the re-entry window (2 hours before start to session end). Timestamps with a `+` offset must be URL-encoded. Follow `nextCursor` while `hasMore` is true; a malformed cursor is a 400.\n\n**Required scope:** `access:read`", "operationId": "get_business_access_bookings", "security": [ { "partnerKey": [] } ], "parameters": [ { "name": "siteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, { "name": "days", "in": "query", "required": false, "schema": { "default": 7, "type": "integer", "minimum": 1, "maximum": 14 } }, { "name": "changedSince", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "format": "base64", "contentEncoding": "base64", "pattern": "^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 100, "type": "integer", "minimum": 1, "maximum": 500 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "const": "booking_feed_entry" }, "bookingId": { "type": "string" }, "status": { "type": "string", "enum": [ "CONFIRMED", "ATTENDED", "CANCELLED" ] }, "member": { "type": "object", "properties": { "memberId": { "type": "string" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "memberId", "barcode" ] }, "session": { "type": "object", "properties": { "sessionId": { "type": "string" }, "name": { "type": "string" }, "sessionTypeId": { "type": "string" }, "status": { "type": "string", "enum": [ "SCHEDULED", "CANCELLED" ] }, "startTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endTime": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "timezone": { "type": "string" }, "roomId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "sessionId", "name", "sessionTypeId", "status", "startTime", "endTime", "timezone", "roomId", "locationId" ] }, "entryWindow": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "to": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "from", "to" ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "object", "bookingId", "status", "member", "session", "entryWindow", "updatedAt" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "serverTime": { "type": "string", "format": "date-time", "description": "When the walk started (the same on every page); pass it back minus an overlap as changedSince." } }, "required": [ "object", "data", "hasMore", "url", "serverTime" ] } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "403": { "description": "The API key does not have the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found. A record that belongs to another brand also returns 404.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] } } } } } } } } }