Skip to main content
GET
/
athletes
List Athletes in Organization
curl --request GET \
  --url https://api.uplift.ai/v1/athletes \
  --header 'Authorization: Bearer <token>'
{
  "athletes": [
    {
      "id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "date_of_birth": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "height": 123,
      "weight": 123,
      "custom_attributes": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

​
Custom Attributes

The endpoint for listing athletes allows for the use of arbitrary query parameters that you define based on your needs. For instance, if your organization uses custom attributes for athletes, you can pass those attributes directly in the query string. Examples of custom attributes might include:
  • sport=MLB
  • team=XYZ
  • age=30
  • position=center
  • Or any other custom attribute based on your organization’s data.
These custom parameters allow you to filter athletes more precisely based on your unique dataset. To learn more about how to properly filter athletes using custom attributes and query parameters, check out examples of Filtering Athletes.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
offset
integer
default:0

Number of records to skip for pagination. Default is 0.

Read more about Retrieving Data in Batches for usage examples.

​
limit
integer
default:100

Number of records to retrieve. Maximum valid value is 500. Default is 100. Use with the offset query parameter to paginate and retrieve more than the first 500 results.

Read more about Retrieving Data in Batches for usage examples.

​
sorted_by
enum<string>

Sort the records by the specified field in the record. Default is null.

Available options:
first_name,
last_name,
date_of_birth

Response

Successful retrieval of athlete records.

​
athletes
object[]

The list of athlete records retrieved.