Hawkin Dynamics
Force Platform API
Programmatic access to your athlete test data, force-time curves, metrics, and athlete management. Built for teams integrating HD data into performance intelligence pipelines.
region-dependent
syncFrom/syncTo
to paginate requests. Responses exceeding the memory limit will fail.
Jump Height(m)
that vary by test type. The
Metrics reference →
lists every field name, unit, and description per test type. Keep it open as a cheat
sheet while you build.
Getting Started
Follow these steps to make your first authenticated API call.
Generate a Refresh Token
Log into your Hawkin Dynamics account as an organization administrator. Navigate to Settings → Integrations and create a new API token. Only org admins can generate tokens.
Exchange for an Access Token
Use your refresh token to obtain a short-lived access token from
/api/token.
Access tokens expire after 1 hour.
Make API Requests
Include the access token in every request as a Bearer token in the
Authorization
header.
Implement Sync Strategy
Use
syncFrom/syncTo
for ongoing scheduled pulls. Use
from/to
for historical bulk exports by month.
Quick Example
Fetch an access token then pull recent test data.
Regional Endpoints
Connect to the region matching your organization's data residency.
| Region | Base URL | Notes |
|---|---|---|
| Americas | https://cloud.hawkindynamics.com |
Default · US data residency |
| Europe | https://eu.cloud.hawkindynamics.com |
EU data residency |
| Asia-Pacific | https://apac.cloud.hawkindynamics.com |
APAC data residency |
Data Sync Strategy
Two recommended patterns for keeping your database current.
Test Metrics
Complete reference for all metrics returned by the API, grouped by test type. The
id shown for each metric is the property name you'll see in API
responses — use these exact strings when accessing test data programmatically.
API Changelog
Changes, additions, and deprecations to the Hawkin Dynamics API.
Center of Pressure (COP) endpoint
Added
GET /api/v1/cop/{test_id}, returning the Center of Pressure time series for a test. Exclusive to the
Free Run test type (other types return
404). Returns
six COP arrays (copX, copY,
leftCopX,
leftCopY,
rightCopX,
rightCopY)
alongside a
Time(s) axis
derived from the capture's sampling rate. COP values are nullable per sample
(null when no
weight is on that plate).
Athlete profile fields on Get Athletes
Added six optional profile fields to
GET /api/v1/athletes
when populated:
image
(three-state — omitted = never set,
null =
explicitly cleared, string = URL),
position,
dob (ISO-8601
date), sport,
height
(centimeters, range [1, 300]), and
lastTestedOn
(Unix epoch seconds). Formally documented
includeInactive
on the athletes endpoint as a boolean with default
false.
includeInactive filter & cursor-based pagination on Get Tests
Added
includeInactive
boolean parameter (default true) to the Get Tests endpoint, allowing filtering to
only active tests. Added opt-in cursor-based pagination via
paginate and
cursor
parameters — returns 1,000 tests per page with
hasMore and
nextCursor in
the response.
Endpoint path updated to /api/v1
The primary data endpoint has been updated from its previous path to
/api/v1. Removed
deprecated configuration section from documentation. All integrations should
update their base endpoint references.
Endpoint standardization
Updated endpoint reference to align with
/api/v1
standard. Improved documentation consistency across all endpoint descriptions.
Bulk athlete operations & team scoping on tests
Added bulk create and bulk update endpoints for athletes (up to 500 per request).
Introduced
teamId and
groupId query
parameters on the tests endpoint supporting comma-separated lists of up to 10 IDs.
Added
testTypeId
query parameter to filter test results by type.
Initial beta API release
Core endpoints for test retrieval, athlete management, force-time data, teams, groups, test types, metrics, and tags. Bearer token authentication via refresh/access token exchange.