REST API Endpoints
Conventions and a curated reference of the Connected Performance REST endpoints an integration is most likely to call: athletes, schedules, workouts, assessments, bookings, payments, messaging, device data and reporting.
Overview
This page is for developers who already have a token (see API Access for Developers) and want to know what to call. It is not the whole API. It lists the resources an integration usually needs, with the exact method and path from the server's route table, who may call it, and the body or query fields that matter. Anything not listed here still exists in the non-production OpenAPI docs at /api-docs.
Every path below is relative to the API host and starts with /api.
How To
Follow the request conventions
Format. Request and response bodies are JSON. Send Content-Type: application/json. Bodies up to 50 MB are accepted; file uploads use multipart/form-data on their own routes.
Organization scoping. The organization comes from the token's user. You never pass an organization id in a body or query string; where a path contains :organizationId it must be your own. Most org-scoped routes also inspect the request origin: a request with neither an Origin header nor an X-Org-Id header is rejected with 403. Headless clients should send X-Org-Id: <your organization id> on every request, not only on login. Routes that need a resolved organization and cannot find one answer 400 with Organization context is required. Please access via an organization subdomain.
Ids. Record ids are positive integers. Routers that validate path ids reject anything else with 400 and Invalid id parameter: "x" is not a valid integer. The exception is workoutTypeId, a UUID string. Relations in request bodies are sent as objects with an id, for example "athlete": { "id": 42 }.
Dates. Two formats, by field:
| Format | Where |
|---|---|
YYYY-MM-DD (date only) | Schedule event start, completed workout dateCompleted, booking occurrenceDate, all startDate / endDate / date filters |
| ISO-8601 datetime, UTC | Availability block and booking startTime / endTime, payment transaction from / to, every created_at / createdAt field |
Date-only values are compared as strings, so a datetime in a startDate filter will not match.
Roles. The tables use these labels. "Member" is any signed-in user of the organization. "Staff" is coach, club coach or admin. "Admin" is the admin role only. Where a route says member but the handler narrows further (an athlete sees only their own records, a parent only their linked athletes), the row says so.
Pagination. There is no single scheme; each list endpoint documents its own. Lists that do not mention paging return the full set.
| Endpoint | Parameters | Notes |
|---|---|---|
GET /api/athletes | page (1-based), limit (max 100) | Paged only when both are sent, then returns { data, pagination: { page, limit, total, totalPages } } |
GET /api/users | limit, page (0-based) | Paged only when limit is sent, then returns { data, total, page, limit } |
GET /api/workouts | page (0-based) | 50 per page |
GET /api/completedWorkouts | page (0-based) | Always capped at 50 rows |
GET /api/questionnaireResponses | page (0-based) | 12 per page when page is sent |
GET /api/chats | page (0-based), limit (max 100) | Default 10 |
GET /api/bookings/payments | limit, offset | Default 25 / 0; exportAll=true returns everything |
GET /api/sms/threads | limit, offset | |
GET /api/payments/invoices | page, pageSize | Paged only when page is sent |
GET /api/payments/customers/:id/... | page (1-based), limit (max 50) | Memberships, transactions, invoices; the ledger allows limit up to 100 |
Rate limiting. Everything under /api shares one limit of 500,000 requests per 60 minutes, keyed by user id (by IP before login). Standard RateLimit-* headers are returned. Over the limit you get 429 with { "error": "Too many requests, please try again later.", "retryAfter": 3600 }. Login, password reset and public checkout routes have much lower per-IP limits.
Compression. List endpoints gzip responses over 3 KB when your client sends Accept-Encoding: gzip. Some lists (/api/workouts, /api/completedWorkouts, /api/completedExercises) are also served from a server-side cache for up to 300 seconds, so a write may take a few seconds to show in a list.
Idempotency. POST /api/completedWorkouts accepts an Idempotency-Key header. A retry with the same key returns the original result with the response header Idempotent-Replayed: true instead of logging the workout twice.
Read error responses
Errors raised through the shared handler have one of two shapes:
5xx responses use { "status": "error", "message": "Internal server error", "code": 500 }. Malformed JSON is 400 with Invalid syntax: .... A few older handlers answer 4xx with a bare { "message": "..." }; treat message at either level as the human-readable reason. Success bodies are not wrapped uniformly: some return the record, some { message, <resource> }, some { status: 'success', ... }. Read the endpoint's shape once and do not assume an envelope.
Athletes and users
| Method | Path | Role | Purpose |
|---|---|---|---|
GET | /api/athletes | Member | List athletes. Staff see the org; athletes and parents see their own. |
GET | /api/athletes/:id | Member | One athlete with level, coaches and groups |
POST | /api/athletes/ | Staff | Create an athlete record (coaches as an array of ids) |
POST | /api/athletes/:id | Staff | Update an athlete |
DELETE | /api/athletes/:id | Staff | Delete an athlete |
GET | /api/athletes/:id/completedWorkouts | Member | Logged workouts for one athlete |
GET | /api/athletes/:id/assessmentResponses | Member | Assessment results for one athlete |
GET | /api/athletes/:id/questionnaireResponses | Member | Questionnaire submissions for one athlete |
GET | /api/athletes/:id/maxes | Member | Personal maxes per exercise |
GET | /api/athletes/:id/performance-stats | Member | Aggregated device and workout stats |
GET | /api/users | Member | Directory. Non-staff get only id, name, role and avatar. |
GET | /api/users/:id | Member | One user |
POST | /api/users/:id | Member | Update a user (role changes are bounded by the caller's own role) |
DELETE | /api/users/:id | Member | Delete a user |
POST | /api/insertUsers | Member | Bulk import: { users: [...], createMissing } |
GET | /api/me | Member | The token's own user |
GET | /api/coaches | Member | Coach directory |
POST | /api/coaches/:id | Admin | Update a coach, including rates |
GET | /api/athleteGroups | Member | Groups in the org |
POST | /api/athleteGroups/ | Staff | Create a group |
POST | /api/athleteGroups/:id/ | Staff | Update a group and its members |
DELETE | /api/athleteGroups/:id | Staff | Delete a group |
GET | /api/athlete-notes | Member | Coach notes (athleteId query) |
POST | /api/athlete-notes | Member | Create a note |
PUT | /api/athlete-notes/:id | Member | Update a note |
DELETE | /api/athlete-notes/:id | Member | Delete a note |
GET | /api/athlete-custom-fields | Member | Custom field definitions |
POST | /api/athlete-custom-fields | Staff | Define a custom field |
PUT | /api/athlete-custom-fields/:id | Staff | Update a definition |
PUT | /api/athlete-custom-fields/mine/:surface/:athleteId | Member | Save an athlete's values for one surface |
Query filters: GET /api/athletes takes search (name, case-insensitive). GET /api/users takes search (name or email) and athleteGroup.
Schedule and workouts
| Method | Path | Role | Purpose |
|---|---|---|---|
GET | /api/athleteSchedules | Member | Schedules. Non-staff must pass athleteV2=<athleteId>. |
GET | /api/athleteSchedules/:athleteId | Member | One athlete's schedule container |
GET | /api/scheduleEvents/athlete/:athleteId | Member | Events in a range: startDate, endDate (YYYY-MM-DD) |
GET | /api/scheduleEvents/:id | Member | One event with its workout or assessment |
POST | /api/scheduleEvents/ | Member | Create an event: athleteSchedule { id }, start, type, title, workout { id } or assessment { id }, priority |
POST | /api/scheduleEvents/athlete/:athleteId/bulk | Member | Create many: { events: [...], upsert } |
PUT | /api/scheduleEvents/:id/ | Member | Update an event |
DELETE | /api/scheduleEvents/:id | Member | Delete an event |
PUT | /api/scheduleEvents/move | Member | Move events to new dates |
POST | /api/scheduleEvents/athlete/:athleteId/applyTemplate | Member | Apply a schedule template from a start date |
POST | /api/scheduleEvents/athlete/:athleteId/shift | Member | Shift a whole schedule by N days |
GET | /api/groupScheduleEvents/groups/:groupId | Member | A group's template events |
POST | /api/groupScheduleEvents/groups/:groupId/bulk | Member | Add group events |
GET | /api/scheduleTemplates | Member | Schedule templates |
GET | /api/workouts | Member | Workout library: search, type, page, orderBy=alphabetical |
GET | /api/workouts/:id | Member | One workout with exercises |
GET | /api/workouts/types | Member | Workout types (workoutTypeId values) |
POST | /api/workouts/ | Member | Create a workout; workoutTypeId is required |
POST | /api/workouts/:id | Member | Update a workout |
POST | /api/workouts/:id/copy | Member | Duplicate a workout |
DELETE | /api/workouts/:id | Member | Delete a workout |
GET | /api/workout-assignments/athlete/:athleteId | Member | Workouts assigned to an athlete |
POST | /api/workout-assignments | Member | Assign a workout to an athlete |
POST | /api/workout-assignments/workout/:workoutId/bulk | Member | Assign one workout to many athletes |
DELETE | /api/workout-assignments/:id | Member | Remove an assignment |
GET | /api/exercises | Member | Exercise library |
GET | /api/exercises/:id | Member | One exercise |
POST | /api/exercises | Member | Create an exercise |
PUT | /api/exercises/:id | Staff | Update an exercise |
DELETE | /api/exercises/:id | Staff | Delete an exercise |
GET | /api/completedWorkouts | Member | Logged workouts: athlete, startDate, endDate, search, type, page |
GET | /api/completedWorkouts/:id | Member | One logged workout with its exercises and sets |
POST | /api/completedWorkouts/ | Member | Log a workout: athlete { id }, title, dateCompleted, workoutTypeId, workoutId, completedExercises[] (each set may include rpe, which is dropped unless the exercise type has trackRpe on), session rpe, strain, time, athleteNotes |
POST | /api/completedWorkouts/:id/ | Staff | Update a logged workout: title, dateCompleted, athleteNotes, time, rpe, workoutTypeId. The server recomputes strain when rpe changes |
DELETE | /api/completedWorkouts/:id | Member | Delete a logged workout |
GET | /api/completedExercises | Member | Set-level history; athlete is required for non-staff |
GET | /api/leaderboard | Member | Leaderboard standings |
Creating a logged workout returns { message, completedWorkout, personalRecords }; personalRecords lists any new maxes the entry set. Schedule event type and status are enums; read an existing event to see the values your organization uses.
Assessments and questionnaires
| Method | Path | Role | Purpose |
|---|---|---|---|
GET | /api/assessments | Member | Assessment definitions |
GET | /api/assessments/:id | Member | One assessment with its items |
POST | /api/assessments/ | Member | Create an assessment |
POST | /api/assessments/:id | Member | Update an assessment |
GET | /api/assessmentResponses | Member | Results: athleteId, assessmentId, dateResponded, graded=true|false |
GET | /api/assessmentResponses/:id | Member | One result with item responses |
POST | /api/assessmentResponses | Member | Record a result: athlete { id }, assessment { id }, dateResponded, assessmentItemResponses[] |
PUT | /api/assessmentResponses/:id/grade | Member | Mark graded |
POST | /api/assessmentResponses/bulk-import | Member | Import historical results |
GET | /api/questionnaires | Member | Questionnaire definitions |
GET | /api/questionnaires/:id | Member | One questionnaire with questions |
POST | /api/questionnaires | Staff | Create a questionnaire |
GET | /api/questionnaireResponses | Member | Submissions: userId, questionnaireId, dateResponded, page |
GET | /api/questionnaireResponses/:id | Member | One submission with question and answer pairs |
POST | /api/questionnaireResponses | Member | Submit: user { id }, questionnaire { id }, dateResponded, questionResponses[] |
Non-staff callers of /api/questionnaireResponses must pass userId; staff who omit it get the whole organization.
Bookings and facility
| Method | Path | Role | Purpose |
|---|---|---|---|
GET | /api/availabilityBlocks | Member | Sessions: startDate, endDate, date, location, coach, activity, type, level, isPaid, camp=only|exclude, hideFullBlocks |
GET | /api/availabilityBlocks/:id | Member | One session |
POST | /api/availabilityBlocks | Staff | Create a session: title, startTime, endTime, location { id }, trainingActivity[], type, isPaid, basePrice, recurringType, recurringEndType, recurringEndDate, seriesOnly, private |
PUT | /api/availabilityBlocks/:id | Staff | Update a session |
PUT | /api/availabilityBlocks/:id/cancel | Staff | Cancel a session and its bookings |
DELETE | /api/availabilityBlocks/:id | Staff | Delete a session |
GET | /api/bookings | Member | Bookings. Athletes see their own. |
GET | /api/bookings/filtered | Staff | Filter by location, space, coach, activity, startDate, endDate, athleteName, level |
GET | /api/bookings/athlete/:athleteId | Member | One athlete's bookings, same filters |
GET | /api/bookings/block/:blockId | Member | Bookings on one session |
POST | /api/bookings | Member | Book: athlete { id }, availabilityBlock { id }, occurrenceDate, startTime, endTime, timezone; recurring: true books the remaining series; an array books several athletes |
PATCH | /api/bookings/:bookingId | Member | Update a booking |
PATCH | /api/bookings/:bookingId/check-in | Staff | Check an athlete in |
PATCH | /api/bookings/:bookingId/payment-status | Staff | Mark paid or unpaid |
DELETE | /api/bookings/:bookingId | Member | Cancel a booking |
GET | /api/bookings/payments | Staff | Booking payment ledger with limit, offset, startDate, endDate, location |
GET | /api/opening-hours | Member | Lesson and rental hours per location |
GET | /api/opening-hours/:locationId/slots | Member | Free slots on a date |
POST | /api/opening-hours/:locationId/book | Member | Book a slot |
PUT | /api/opening-hours/:locationId | Admin | Set hours, lengths and prices |
GET | /api/locations | Member | Locations |
POST | /api/locations | Staff | Create a location |
PUT | /api/locations/:id | Staff | Update a location |
GET | /api/locations/:locationId/spaces | Member | Spaces (cages, mounds) at a location |
POST | /api/locations/:locationId/spaces | Staff | Create a space |
PUT | /api/spaces/:id | Staff | Update a space |
GET | /api/training-activities | Member | Activities |
POST | /api/training-activities | Staff | Create an activity |
GET | /api/levels | Member | Athlete levels |
GET | /api/booking-rules | Member | Booking rules |
POST | /api/booking-rules | Staff | Create a rule (MAX_BOOKINGS_PER_WEEK, ADVANCE_BOOKING_WINDOW, HOURS_BEFORE_START, CANCELLATION_WINDOW) |
PUT | /api/booking-rules/:ruleId | Staff | Update a rule |
GET | /api/equipment | Staff | Equipment inventory |
POST | /api/bookings/:bookingId/equipment | Staff | Reserve equipment on a booking |
Session type is one of group, one_on_one, team, camp. Only admins may send alreadyPaid: true on a camp booking; anyone else gets 403 with Only admins can record a booking as already paid. A parent booking for an athlete they are not linked to gets 403 with Not authorized to book for this athlete.
Payments
Every payments route accepts any member, and the handler then enforces the role. Reads and writes on other people's records require admin and otherwise fail with 403 and Only administrators can perform this action. The my-billing and my-balance routes are for the signed-in customer.
| Method | Path | Role | Purpose |
|---|---|---|---|
GET | /api/payments/customers | Admin | Payment customers |
GET | /api/payments/customers/:id | Admin | One customer |
GET | /api/payments/customers/by-athlete/:athleteId | Admin | Customer linked to an athlete |
POST | /api/payments/customers | Admin | Create a customer |
GET | /api/payments/customers/:id/memberships | Admin | Paged memberships |
GET | /api/payments/customers/:id/transactions | Admin | Paged transactions |
GET | /api/payments/customers/:id/invoices | Admin | Paged invoices |
GET | /api/payments/customers/:id/ledger | Admin | Paged credit ledger |
GET | /api/payments/customers/:customerId/schedule | Admin | Upcoming charges: status, from, to, membershipId, limit |
GET | /api/payments/plans | Admin | Plans |
POST | /api/payments/plans | Admin | Create a plan |
PUT | /api/payments/plans/:id | Admin | Update a plan |
GET | /api/payments/memberships | Admin | Memberships (also served at /api/payments/enrollments) |
POST | /api/payments/memberships | Admin | Enrol a customer in a plan |
PUT | /api/payments/memberships/:id | Admin | Update a membership |
POST | /api/payments/memberships/:id/payment-link | Admin | Mint a pay link |
GET | /api/payments/invoices | Admin | Invoices: status, search, customerId, invoiceNumber, dueDate, page, pageSize |
GET | /api/payments/invoices/:id | Admin | One invoice |
POST | /api/payments/invoices | Admin | Create an invoice |
PUT | /api/payments/invoices/:id | Admin | Update an invoice |
GET | /api/payments/transactions | Admin | Transactions |
GET | /api/payments/transactions/:id | Admin | One transaction |
POST | /api/payments/transactions/:id/charge-now | Admin | Charge a scheduled transaction now |
POST | /api/payments/transactions/:id/cancel | Admin | Cancel a scheduled transaction |
GET | /api/payments/transactions/analytics-summary | Admin | Revenue summary |
GET | /api/credits/packages | Admin | Credit packages |
POST | /api/credits/packages | Admin | Create a package |
GET | /api/credits/types | Member | Credit types |
GET | /api/credits/balance/:customerId | Admin | A customer's credit balance |
POST | /api/credits/adjust | Admin | Add or remove credits |
GET | /api/discount-codes | Admin | Discount codes |
POST | /api/discount-codes | Admin | Create a code |
POST | /api/discount-codes/preview | Member | Price a code against a purchase |
GET | /api/payments/my-billing | Member | The caller's own billing |
GET | /api/credits/my-balance | Member | The caller's own credits |
Messaging
| Method | Path | Role | Purpose |
|---|---|---|---|
GET | /api/chats | Member | The caller's chats: search, page, limit |
GET | /api/chats/:id | Member | One chat with a page of messages (page, 0-based) |
POST | /api/chats | Member | Create a chat: users[], isGroup, title |
GET | /api/messages | Member | A 1:1 thread: senderId, recipientId; one must be the caller |
GET | /api/messages/search | Member | Search message bodies |
POST | /api/messages | Member | Send: body plus chat { id } or recipient { id }. The sender is always the token's user. |
POST | /api/messages/broadcast | Staff | Queue a broadcast: body, audienceType, optional audience, channels, sendAt. Legacy recipientIds still works. Sending runs in the background. |
POST | /api/messages/broadcast/preview | Staff | Count (and sample) the resolved audience without sending |
GET | /api/messages/broadcasts | Staff | Recent campaigns with delivered/read counts |
GET | /api/messages/broadcasts/:id | Staff | One campaign |
GET | /api/messages/broadcasts/filters | Staff | Saved audience filters |
POST | /api/messages/broadcasts/filters | Staff | Save an audience filter: name, audienceType, audience |
DELETE | /api/messages/broadcasts/filters/:id | Staff | Delete a saved filter |
GET | /api/sms/threads | Staff | Texting threads: limit, offset |
GET | /api/sms/threads/:id | Staff | One thread with messages |
POST | /api/sms/threads | Staff | Start a thread: userId or phone |
POST | /api/sms/threads/:id/messages | Staff | Send a text |
Posting into an announcement chat is limited to staff; others get 403 with Only coaches and admins can post in this channel. Texting routes require the Texting feature to be enabled.
Performance data
All device data follows one pattern. Reads are open to the athlete, a linked parent, or staff of the athlete's organization. Writes are staff only. List routes take athlete=<athleteId>; staff may omit it to get the whole organization, everyone else must send it or receives 400 with athlete is required. Bulk DELETE on a list route requires athlete.
| Resource | List and create path | Detail path | Update verb |
|---|---|---|---|
| Rapsodo pitches | /api/rapsodoPitches | /api/rapsodoPitches/:id | POST |
| Rapsodo hits | /api/rapsodoHits | /api/rapsodoHits/:id | POST |
| Rapsodo hitting sessions | /api/rapsodoHittingSessions | /api/rapsodoHittingSessions/:id | POST |
| Trackman pitches | /api/trackmanPitches | /api/trackmanPitches/:id | PUT |
| Trackman sessions | /api/trackmanSessions | /api/trackmanSessions/:id | PUT |
| Blast Motion swings | /api/blastMotionEntries | /api/blastMotionEntries/:id | PUT |
| ArmCare entries | /api/armCareEntries | /api/armCareEntries/:id | POST |
| Pocket Radar sessions | /api/pocketRadarSessions | /api/pocketRadarSessions/:id | none |
| PitchLogic | /api/pitchLogic | /api/pitchLogic/:id | PUT |
Each supports GET list, POST create (body or array of bodies, each with athlete { id }), GET detail, DELETE detail and DELETE list by athlete. Pocket Radar sessions may also be created by the athlete for themselves. VALD tests are read at GET /api/vald/tests (athleteId query) and GET /api/vald/tests/:id; POST /api/vald/sync pulls new tests from VALD.
Resources and reporting
| Method | Path | Role | Purpose |
|---|---|---|---|
GET | /api/resources | Member | Resources visible to the caller |
GET | /api/resources/:id | Member | One resource |
POST | /api/resources | Admin | Create a resource |
PUT | /api/resources/:id | Admin | Update a resource |
PUT | /api/resources/:id/assignments | Coach, admin | Assign to athletes or groups |
GET | /api/resources/:id/completions | Staff | Who has completed it |
POST | /api/resources/:id/complete | Member | Mark complete for the caller |
GET | /api/reporting/:athleteId | Member | Single athlete report |
GET | /api/reporting/organization/:organizationId | Member | Organization report |
GET | /api/reporting/organization/:organizationId/exercise/:exerciseId | Member | Exercise report across the org |
GET | /api/reporting/organization/:organizationId/assessments | Member | Assessment report |
GET | /api/reporting/inactive-users | Member | Users with no recent login |
GET | /api/availabilityBlocks/report-stats | Staff | Facility stats: startDate, endDate (max 366 days), locationId |
Tips
- Send
X-Org-Idon every request from a server. It is what satisfies the origin check; without it most org-scoped routes answer403even with a valid token. - Prefer the per-athlete sub-routes (
/api/athletes/:id/completedWorkouts,/api/scheduleEvents/athlete/:athleteId) over filtering a whole-org list. They are smaller and are not cached. GET /api/completedWorkoutsnever returns more than 50 rows. Page withpage=0,1,2...and stop when a page comes back short.- For a list that is paged only on demand (
/api/athletes,/api/users,/api/payments/invoices), the unpaged form returns a bare array and the paged form returns an envelope. Handle both if you ever change the call. - Use
Idempotency-Keyon workout logging from a device or queue. A network retry will not double-count the session.
Troubleshooting
Every org-scoped call returns 403 but /api/me works.
No Origin and no X-Org-Id header. Add X-Org-Id with your organization's numeric id.
400 "Organization context is required".
The route needs a resolved organization and the request did not carry one. Same fix: send X-Org-Id.
400 "Invalid id parameter".
A path id was not an integer (often the string undefined or NaN from a client bug).
athlete is required on a device-data list.
The token is an athlete or parent account. Pass athlete=<id> for an athlete that account may read, or use a staff token.
POST succeeded but the list does not show the record.
/api/workouts, /api/completedWorkouts and /api/completedExercises are cached for up to 300 seconds. Read the record by id or wait.
403 "Only administrators can perform this action" on a payments route. The route is open to any member but the handler requires the admin role. Use an admin token.
Related
- API Access for Developers
- Connected Apps (MCP)
- Zapier & Webhooks
- User Roles & Permissions
Referenced by
- 'Zapier & Webhooks'integrations