Wingfield Logo
Wingfield Partner API
User

List coaches for user

GET
/api/v1/users/{userId}/coaches

List active coaches for a user connected to your external service. Only coaches also connected to your external service are returned.

Required Scopes:
coaching-relationshipread

Path Parameters

userId*string

Wingfield user identifier.

Formatuuid

Query Parameters

offset?integer

Number of items to skip.

Default0
Range0 <= value
limit?integer

Maximum number of items to return.

Default50
Range1 <= value <= 100

Error Responses

400

invalid_schema

Request validation failed.

401

missing_api_token

No authentication token provided.

401

invalid_api_token

Invalid or expired authentication token.

403

scope_permission_denied

Insufficient permissions for this operation.

403

user_access_denied

Service is not granted access to the user.

curl -X GET "https://dev.wingfield.systems/api/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/coaches"
{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "firstName": "string",
      "lastName": "string",
      "birthday": "2019-08-24T14:15:22Z",
      "gender": "MALE",
      "mainSportType": "TENNIS",
      "playingHand": "LEFT"
    }
  ],
  "totalCount": 0
}
{
  "error": {
    "type": "invalid_schema",
    "message": "string",
    "issues": [
      {}
    ]
  }
}
{
  "error": {
    "type": "missing_api_token",
    "message": "string"
  }
}
{
  "error": {
    "type": "scope_permission_denied",
    "message": "string"
  }
}