Connected Performance
Integrations

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:

FormatWhere
YYYY-MM-DD (date only)Schedule event start, completed workout dateCompleted, booking occurrenceDate, all startDate / endDate / date filters
ISO-8601 datetime, UTCAvailability 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.

EndpointParametersNotes
GET /api/athletespage (1-based), limit (max 100)Paged only when both are sent, then returns { data, pagination: { page, limit, total, totalPages } }
GET /api/userslimit, page (0-based)Paged only when limit is sent, then returns { data, total, page, limit }
GET /api/workoutspage (0-based)50 per page
GET /api/completedWorkoutspage (0-based)Always capped at 50 rows
GET /api/questionnaireResponsespage (0-based)12 per page when page is sent
GET /api/chatspage (0-based), limit (max 100)Default 10
GET /api/bookings/paymentslimit, offsetDefault 25 / 0; exportAll=true returns everything
GET /api/sms/threadslimit, offset
GET /api/payments/invoicespage, pageSizePaged 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:

{ "status": "fail", "data": { "message": "Insufficient privileges for this resource" } }
{ "status": "fail", "data": { "validationErrors": { "startDate": "Start date must be a valid YYYY-MM-DD date" } } }

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

MethodPathRolePurpose
GET/api/athletesMemberList athletes. Staff see the org; athletes and parents see their own.
GET/api/athletes/:idMemberOne athlete with level, coaches and groups
POST/api/athletes/StaffCreate an athlete record (coaches as an array of ids)
POST/api/athletes/:idStaffUpdate an athlete
DELETE/api/athletes/:idStaffDelete an athlete
GET/api/athletes/:id/completedWorkoutsMemberLogged workouts for one athlete
GET/api/athletes/:id/assessmentResponsesMemberAssessment results for one athlete
GET/api/athletes/:id/questionnaireResponsesMemberQuestionnaire submissions for one athlete
GET/api/athletes/:id/maxesMemberPersonal maxes per exercise
GET/api/athletes/:id/performance-statsMemberAggregated device and workout stats
GET/api/usersMemberDirectory. Non-staff get only id, name, role and avatar.
GET/api/users/:idMemberOne user
POST/api/users/:idMemberUpdate a user (role changes are bounded by the caller's own role)
DELETE/api/users/:idMemberDelete a user
POST/api/insertUsersMemberBulk import: { users: [...], createMissing }
GET/api/meMemberThe token's own user
GET/api/coachesMemberCoach directory
POST/api/coaches/:idAdminUpdate a coach, including rates
GET/api/athleteGroupsMemberGroups in the org
POST/api/athleteGroups/StaffCreate a group
POST/api/athleteGroups/:id/StaffUpdate a group and its members
DELETE/api/athleteGroups/:idStaffDelete a group
GET/api/athlete-notesMemberCoach notes (athleteId query)
POST/api/athlete-notesMemberCreate a note
PUT/api/athlete-notes/:idMemberUpdate a note
DELETE/api/athlete-notes/:idMemberDelete a note
GET/api/athlete-custom-fieldsMemberCustom field definitions
POST/api/athlete-custom-fieldsStaffDefine a custom field
PUT/api/athlete-custom-fields/:idStaffUpdate a definition
PUT/api/athlete-custom-fields/mine/:surface/:athleteIdMemberSave 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

MethodPathRolePurpose
GET/api/athleteSchedulesMemberSchedules. Non-staff must pass athleteV2=<athleteId>.
GET/api/athleteSchedules/:athleteIdMemberOne athlete's schedule container
GET/api/scheduleEvents/athlete/:athleteIdMemberEvents in a range: startDate, endDate (YYYY-MM-DD)
GET/api/scheduleEvents/:idMemberOne event with its workout or assessment
POST/api/scheduleEvents/MemberCreate an event: athleteSchedule { id }, start, type, title, workout { id } or assessment { id }, priority
POST/api/scheduleEvents/athlete/:athleteId/bulkMemberCreate many: { events: [...], upsert }
PUT/api/scheduleEvents/:id/MemberUpdate an event
DELETE/api/scheduleEvents/:idMemberDelete an event
PUT/api/scheduleEvents/moveMemberMove events to new dates
POST/api/scheduleEvents/athlete/:athleteId/applyTemplateMemberApply a schedule template from a start date
POST/api/scheduleEvents/athlete/:athleteId/shiftMemberShift a whole schedule by N days
GET/api/groupScheduleEvents/groups/:groupIdMemberA group's template events
POST/api/groupScheduleEvents/groups/:groupId/bulkMemberAdd group events
GET/api/scheduleTemplatesMemberSchedule templates
GET/api/workoutsMemberWorkout library: search, type, page, orderBy=alphabetical
GET/api/workouts/:idMemberOne workout with exercises
GET/api/workouts/typesMemberWorkout types (workoutTypeId values)
POST/api/workouts/MemberCreate a workout; workoutTypeId is required
POST/api/workouts/:idMemberUpdate a workout
POST/api/workouts/:id/copyMemberDuplicate a workout
DELETE/api/workouts/:idMemberDelete a workout
GET/api/workout-assignments/athlete/:athleteIdMemberWorkouts assigned to an athlete
POST/api/workout-assignmentsMemberAssign a workout to an athlete
POST/api/workout-assignments/workout/:workoutId/bulkMemberAssign one workout to many athletes
DELETE/api/workout-assignments/:idMemberRemove an assignment
GET/api/exercisesMemberExercise library
GET/api/exercises/:idMemberOne exercise
POST/api/exercisesMemberCreate an exercise
PUT/api/exercises/:idStaffUpdate an exercise
DELETE/api/exercises/:idStaffDelete an exercise
GET/api/completedWorkoutsMemberLogged workouts: athlete, startDate, endDate, search, type, page
GET/api/completedWorkouts/:idMemberOne logged workout with its exercises and sets
POST/api/completedWorkouts/MemberLog 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/StaffUpdate a logged workout: title, dateCompleted, athleteNotes, time, rpe, workoutTypeId. The server recomputes strain when rpe changes
DELETE/api/completedWorkouts/:idMemberDelete a logged workout
GET/api/completedExercisesMemberSet-level history; athlete is required for non-staff
GET/api/leaderboardMemberLeaderboard 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

MethodPathRolePurpose
GET/api/assessmentsMemberAssessment definitions
GET/api/assessments/:idMemberOne assessment with its items
POST/api/assessments/MemberCreate an assessment
POST/api/assessments/:idMemberUpdate an assessment
GET/api/assessmentResponsesMemberResults: athleteId, assessmentId, dateResponded, graded=true|false
GET/api/assessmentResponses/:idMemberOne result with item responses
POST/api/assessmentResponsesMemberRecord a result: athlete { id }, assessment { id }, dateResponded, assessmentItemResponses[]
PUT/api/assessmentResponses/:id/gradeMemberMark graded
POST/api/assessmentResponses/bulk-importMemberImport historical results
GET/api/questionnairesMemberQuestionnaire definitions
GET/api/questionnaires/:idMemberOne questionnaire with questions
POST/api/questionnairesStaffCreate a questionnaire
GET/api/questionnaireResponsesMemberSubmissions: userId, questionnaireId, dateResponded, page
GET/api/questionnaireResponses/:idMemberOne submission with question and answer pairs
POST/api/questionnaireResponsesMemberSubmit: 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

MethodPathRolePurpose
GET/api/availabilityBlocksMemberSessions: startDate, endDate, date, location, coach, activity, type, level, isPaid, camp=only|exclude, hideFullBlocks
GET/api/availabilityBlocks/:idMemberOne session
POST/api/availabilityBlocksStaffCreate a session: title, startTime, endTime, location { id }, trainingActivity[], type, isPaid, basePrice, recurringType, recurringEndType, recurringEndDate, seriesOnly, private
PUT/api/availabilityBlocks/:idStaffUpdate a session
PUT/api/availabilityBlocks/:id/cancelStaffCancel a session and its bookings
DELETE/api/availabilityBlocks/:idStaffDelete a session
GET/api/bookingsMemberBookings. Athletes see their own.
GET/api/bookings/filteredStaffFilter by location, space, coach, activity, startDate, endDate, athleteName, level
GET/api/bookings/athlete/:athleteIdMemberOne athlete's bookings, same filters
GET/api/bookings/block/:blockIdMemberBookings on one session
POST/api/bookingsMemberBook: athlete { id }, availabilityBlock { id }, occurrenceDate, startTime, endTime, timezone; recurring: true books the remaining series; an array books several athletes
PATCH/api/bookings/:bookingIdMemberUpdate a booking
PATCH/api/bookings/:bookingId/check-inStaffCheck an athlete in
PATCH/api/bookings/:bookingId/payment-statusStaffMark paid or unpaid
DELETE/api/bookings/:bookingIdMemberCancel a booking
GET/api/bookings/paymentsStaffBooking payment ledger with limit, offset, startDate, endDate, location
GET/api/opening-hoursMemberLesson and rental hours per location
GET/api/opening-hours/:locationId/slotsMemberFree slots on a date
POST/api/opening-hours/:locationId/bookMemberBook a slot
PUT/api/opening-hours/:locationIdAdminSet hours, lengths and prices
GET/api/locationsMemberLocations
POST/api/locationsStaffCreate a location
PUT/api/locations/:idStaffUpdate a location
GET/api/locations/:locationId/spacesMemberSpaces (cages, mounds) at a location
POST/api/locations/:locationId/spacesStaffCreate a space
PUT/api/spaces/:idStaffUpdate a space
GET/api/training-activitiesMemberActivities
POST/api/training-activitiesStaffCreate an activity
GET/api/levelsMemberAthlete levels
GET/api/booking-rulesMemberBooking rules
POST/api/booking-rulesStaffCreate a rule (MAX_BOOKINGS_PER_WEEK, ADVANCE_BOOKING_WINDOW, HOURS_BEFORE_START, CANCELLATION_WINDOW)
PUT/api/booking-rules/:ruleIdStaffUpdate a rule
GET/api/equipmentStaffEquipment inventory
POST/api/bookings/:bookingId/equipmentStaffReserve 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.

MethodPathRolePurpose
GET/api/payments/customersAdminPayment customers
GET/api/payments/customers/:idAdminOne customer
GET/api/payments/customers/by-athlete/:athleteIdAdminCustomer linked to an athlete
POST/api/payments/customersAdminCreate a customer
GET/api/payments/customers/:id/membershipsAdminPaged memberships
GET/api/payments/customers/:id/transactionsAdminPaged transactions
GET/api/payments/customers/:id/invoicesAdminPaged invoices
GET/api/payments/customers/:id/ledgerAdminPaged credit ledger
GET/api/payments/customers/:customerId/scheduleAdminUpcoming charges: status, from, to, membershipId, limit
GET/api/payments/plansAdminPlans
POST/api/payments/plansAdminCreate a plan
PUT/api/payments/plans/:idAdminUpdate a plan
GET/api/payments/membershipsAdminMemberships (also served at /api/payments/enrollments)
POST/api/payments/membershipsAdminEnrol a customer in a plan
PUT/api/payments/memberships/:idAdminUpdate a membership
POST/api/payments/memberships/:id/payment-linkAdminMint a pay link
GET/api/payments/invoicesAdminInvoices: status, search, customerId, invoiceNumber, dueDate, page, pageSize
GET/api/payments/invoices/:idAdminOne invoice
POST/api/payments/invoicesAdminCreate an invoice
PUT/api/payments/invoices/:idAdminUpdate an invoice
GET/api/payments/transactionsAdminTransactions
GET/api/payments/transactions/:idAdminOne transaction
POST/api/payments/transactions/:id/charge-nowAdminCharge a scheduled transaction now
POST/api/payments/transactions/:id/cancelAdminCancel a scheduled transaction
GET/api/payments/transactions/analytics-summaryAdminRevenue summary
GET/api/credits/packagesAdminCredit packages
POST/api/credits/packagesAdminCreate a package
GET/api/credits/typesMemberCredit types
GET/api/credits/balance/:customerIdAdminA customer's credit balance
POST/api/credits/adjustAdminAdd or remove credits
GET/api/discount-codesAdminDiscount codes
POST/api/discount-codesAdminCreate a code
POST/api/discount-codes/previewMemberPrice a code against a purchase
GET/api/payments/my-billingMemberThe caller's own billing
GET/api/credits/my-balanceMemberThe caller's own credits

Messaging

MethodPathRolePurpose
GET/api/chatsMemberThe caller's chats: search, page, limit
GET/api/chats/:idMemberOne chat with a page of messages (page, 0-based)
POST/api/chatsMemberCreate a chat: users[], isGroup, title
GET/api/messagesMemberA 1:1 thread: senderId, recipientId; one must be the caller
GET/api/messages/searchMemberSearch message bodies
POST/api/messagesMemberSend: body plus chat { id } or recipient { id }. The sender is always the token's user.
POST/api/messages/broadcastStaffQueue a broadcast: body, audienceType, optional audience, channels, sendAt. Legacy recipientIds still works. Sending runs in the background.
POST/api/messages/broadcast/previewStaffCount (and sample) the resolved audience without sending
GET/api/messages/broadcastsStaffRecent campaigns with delivered/read counts
GET/api/messages/broadcasts/:idStaffOne campaign
GET/api/messages/broadcasts/filtersStaffSaved audience filters
POST/api/messages/broadcasts/filtersStaffSave an audience filter: name, audienceType, audience
DELETE/api/messages/broadcasts/filters/:idStaffDelete a saved filter
GET/api/sms/threadsStaffTexting threads: limit, offset
GET/api/sms/threads/:idStaffOne thread with messages
POST/api/sms/threadsStaffStart a thread: userId or phone
POST/api/sms/threads/:id/messagesStaffSend 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.

ResourceList and create pathDetail pathUpdate verb
Rapsodo pitches/api/rapsodoPitches/api/rapsodoPitches/:idPOST
Rapsodo hits/api/rapsodoHits/api/rapsodoHits/:idPOST
Rapsodo hitting sessions/api/rapsodoHittingSessions/api/rapsodoHittingSessions/:idPOST
Trackman pitches/api/trackmanPitches/api/trackmanPitches/:idPUT
Trackman sessions/api/trackmanSessions/api/trackmanSessions/:idPUT
Blast Motion swings/api/blastMotionEntries/api/blastMotionEntries/:idPUT
ArmCare entries/api/armCareEntries/api/armCareEntries/:idPOST
Pocket Radar sessions/api/pocketRadarSessions/api/pocketRadarSessions/:idnone
PitchLogic/api/pitchLogic/api/pitchLogic/:idPUT

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

MethodPathRolePurpose
GET/api/resourcesMemberResources visible to the caller
GET/api/resources/:idMemberOne resource
POST/api/resourcesAdminCreate a resource
PUT/api/resources/:idAdminUpdate a resource
PUT/api/resources/:id/assignmentsCoach, adminAssign to athletes or groups
GET/api/resources/:id/completionsStaffWho has completed it
POST/api/resources/:id/completeMemberMark complete for the caller
GET/api/reporting/:athleteIdMemberSingle athlete report
GET/api/reporting/organization/:organizationIdMemberOrganization report
GET/api/reporting/organization/:organizationId/exercise/:exerciseIdMemberExercise report across the org
GET/api/reporting/organization/:organizationId/assessmentsMemberAssessment report
GET/api/reporting/inactive-usersMemberUsers with no recent login
GET/api/availabilityBlocks/report-statsStaffFacility stats: startDate, endDate (max 366 days), locationId

Tips

  • Send X-Org-Id on every request from a server. It is what satisfies the origin check; without it most org-scoped routes answer 403 even 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/completedWorkouts never returns more than 50 rows. Page with page=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-Key on 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.

  • API Access for Developers
  • Connected Apps (MCP)
  • Zapier & Webhooks
  • User Roles & Permissions

Referenced by

On this page