API Endpoints
Authentication
Integrations
Coach management
Registers a new coach with credentials and integration specifics.
Unique identifier for the coach, generated by the server.
Identifier of the coach on the provider's systems
ID of the coach on your system
Region in which the coach operates.
Integration provider associated with the coach (e.g., VALD, Catapult).
The date and time when the coach was registered.
Public identifier for the coach.
Secret key or token for authentication.
API key or token for the coach object
Coach created successfully
Invalid input, object invalid
The coach already exists for your dev-id
Deletes a coach and all associated athletes, activities, and tests.
Unique identifier of the coach to be deleted.
Coach deleted successfully.
Coach not found.
No content
Coach Data retrieval
An array of athletes coached by the specified coach
An array of athletes coached by the specified coach
Start date for the query range (YYYY-MM-DD).
2025-01-01End date for the query range (YYYY-MM-DD). Defaults to start_date + 1 day if omitted.
2025-01-07When true, data is sent asynchronously to your configured webhook and the endpoint returns HTTP 202 with a reference ID. When false (default), data is returned inline in the response body.
falsePossible values: List of activities within the specified time range for all athletes under the coach
Data dispatch accepted. Returned when to_destination=true. Data will be sent to your configured webhook.
Returns the schema of activity metrics available for the specified coach.
Unique identifier of the coach.
When true, data is sent asynchronously to your configured webhook and the endpoint returns HTTP 202 with a reference ID. When false (default), data is returned inline in the response body.
falsePossible values: Schema retrieved successfully.
Data dispatch accepted. Returned when to_destination=true. Data will be sent to your configured webhook.
Coach not found.
Start date for the query range (YYYY-MM-DD).
2025-01-01End date for the query range (YYYY-MM-DD). Defaults to start_date + 1 day if omitted.
2025-01-07When true, data is sent asynchronously to your configured webhook and the endpoint returns HTTP 202 with a reference ID. When false (default), data is returned inline in the response body.
falsePossible values: List of tests within the specified time range for all athletes under the coach
Data dispatch accepted. Returned when to_destination=true. Data will be sent to your configured webhook.
Athlete Management
The ID of the coach to which the athlete belongs
Unique identifier for the athlete, generated by the server.
Unique identifier for the athlete on the provider's system, generated by the provider (e.g. VALD, Catapult)
A string to reference the Athlete. This can be a UUID, email, or other, and can be used to reconcile the Athlete with your internal systems.
Integration provider associated with the Athlete (e.g., VALD, Catapult).
Athlete's first name.
Athlete's last name
Athlete's email
The date and time when the athlete was registered.
The date of birth of the athlete
The date and time when the athlete was last updated (e.g. updated their first and last name).
Determines whether or not Terra will send webhooks for the given athlete
Athlete updated
No content
Athlete updated
No content
Allows a developer to partially update multiple athlete records in a single request.
Your developer ID
testingTerraYour API key
OtHJok60oQmT8zhnUWc4SWBJI7ztPTs88C0gOsJJAll athlete updates were successful.
Partial success, some athletes updated while others failed.
Bad Request. Invalid input or all updates failed due to validation errors.
Unauthorized. Invalid credentials provided.
Detailed information about the athlete
The ID of the coach to which the athlete belongs
Unique identifier for the athlete, generated by the server.
Unique identifier for the athlete on the provider's system, generated by the provider (e.g. VALD, Catapult)
A string to reference the Athlete. This can be a UUID, email, or other, and can be used to reconcile the Athlete with your internal systems.
Integration provider associated with the Athlete (e.g., VALD, Catapult).
Athlete's first name.
Athlete's last name
Athlete's email
The date and time when the athlete was registered.
The date of birth of the athlete
The date and time when the athlete was last updated (e.g. updated their first and last name).
Determines whether or not Terra will send webhooks for the given athlete
Detailed information about the athlete
Last updated
Was this helpful?