LE-KO Coach Explorer API (v1.0.3)

Download OpenAPI specification:

LE-KO API for exploring and finding coaches.

explorer

APIs related to finding and exploring coaches.

Get starter coach recommendations for an athlete

✨ Retrieves up to 5 coach recommendations tailored for a specific athlete to facilitate discovery

Authorizations:
bearerHttpAuthentication
path Parameters
athleteId
required
string <uuid> (Id) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...
Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf

The ID of the athlete for whom to get recommendations.

query Parameters
latitude
number <float>

Optional latitude to inform user of coach distance.

longitude
number <float>

Optional longitude to inform user of coach distance.

header Parameters
traceparent
string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-...
Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01

W3C Trace Context traceparent header for request tracing

Responses

Response Schema: application/json
Array
coachId
required
string <uuid> (Id) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Database entity primary key uuid

sportId
required
string or null <uuid> = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Database entity primary key uuid

coachServicePictureIds
required
Array of strings or null <uuid> (Id) [ items <uuid > = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... ]
formattedAddress
required
string or null

A single string representing the coach's primary location or service area.

distanceFromUser
required
integer or null

The distance, in meters, from the requesting user. Null if no geo location is provided.

priceRangeStart
required
integer or null
priceRangeEnd
required
integer or null
timeRangeStart
required
integer or null

Minimum session duration offered by the coach, in minutes.

timeRangeEnd
required
integer or null

Maximum session duration offered by the coach, in minutes.

Response samples

Content type
application/json
[
  • {
    • "coachId": "4b72d209-debd-45e1-93cc-7640bf7d39bf",
    • "sportId": "4b72d209-debd-45e1-93cc-7640bf7d39bf",
    • "coachServicePictureIds": [
      • "4b72d209-debd-45e1-93cc-7640bf7d39bf"
      ],
    • "formattedAddress": "string",
    • "distanceFromUser": 0,
    • "priceRangeStart": 0,
    • "priceRangeEnd": 0,
    • "timeRangeStart": 0,
    • "timeRangeEnd": 0
    }
]

Get filtered coaches

✨ Lists coaches according to a set of filters.

Authorizations:
bearerHttpAuthentication
query Parameters
coachIds
Array of strings <uuid> [ items <uuid > ]

Coaches to filter by. Mainly used to filter through recommended coaches.

sportIds
Array of strings <uuid> (Id) [ items <uuid > = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... ]
Example: sportIds=4b72d209-debd-45e1-93cc-7640bf7d39bf
format
string
Enum: "online" "offline"
sessionType
string
Enum: "group" "personal"
skill
string
Enum: "beginner" "intermediate" "pro" "all"
ageFrom
integer
ageTo
integer
locationMaxDistanceMeters
integer >= 0
locationUserLatitude
number <double>
locationUserLongitude
number <double>
minPrice
integer >= 0

Minimum (inclusive) price

maxPrice
integer >= 0

Maximum (inclusive) price

eligibility
string
Enum: "men" "women" "all"

Filter coaches by gender eligibility (men, women, or all)

startTime
string <date-time>

Filter coaches which have sessions starting at around this time. Although date-time is used, only the time is relevant for filtering.

endTime
string <date-time>

Filter coaches which have sessions ending at around this time. Although date-time is used, only the time is relevant for filtering.

userId
string <uuid>

The ID of the user performing the request. Used to filter them out of results.

header Parameters
traceparent
string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-...
Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01

W3C Trace Context traceparent header for request tracing

Responses

Response Schema: application/json
Array
coachId
required
string <uuid>
serviceId
required
string <uuid>
timeSlotIds
required
Array of strings <uuid> [ items <uuid > ]

Response samples

Content type
application/json
[
  • {
    • "coachId": "32b8fa03-4065-4b2f-b4b6-8ce1e570e87e",
    • "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9",
    • "timeSlotIds": [
      • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
]

Get summary of coach services

✨ Returns a summary of coach services

Authorizations:
bearerHttpAuthentication
path Parameters
coachId
required
string <uuid>

Identifier of the coach.

query Parameters
userLatitude
number <double>

User latitude. Used to calculate distance.

userLongitude
number <double>

User longitude. Used to calculate distance.

serviceId
string <uuid>

May be used to get the summary of the coach for a specific service. Useful when the coach offers multiple services and you need a summary for a particular one.

timeslotIds
Array of strings <uuid> [ items <uuid > ]
header Parameters
traceparent
string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-...
Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01

W3C Trace Context traceparent header for request tracing

Responses

Response Schema: application/json
mainServiceId
required
string or null <uuid>
mainSportId
required
string or null <uuid>
mainServicePhotoIds
required
Array of strings or null <uuid> [ items <uuid > ]
formattedAddress
required
string or null
priceRangeMin
required
integer or null
priceRangeMax
required
integer or null
durationMin
required
integer or null
durationMax
required
integer or null
distanceFromUser
required
integer or null

The distance from user in meters.

serviceSkillLevels
required
Array of strings
serviceEligibilities
required
Array of strings

Response samples

Content type
application/json
{
  • "mainServiceId": "33dcf7d5-36e5-49e5-8d04-7022464e45f4",
  • "mainSportId": "fded0f56-2b4a-4888-8bae-5762881ddae8",
  • "mainServicePhotoIds": [
    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
  • "formattedAddress": "string",
  • "priceRangeMin": 0,
  • "priceRangeMax": 0,
  • "durationMin": 0,
  • "durationMax": 0,
  • "distanceFromUser": 0,
  • "serviceSkillLevels": [
    • "string"
    ],
  • "serviceEligibilities": [
    • "string"
    ]
}