Varje rutt, i sin helhet

Your profile

Account fields and the handicap held on your player record.

Returns MeProfile

• userId string (uuid) — The account id; the same value as the token subject.
• playerId string (uuid) · optional — The player id every round, score and statistic is keyed by. Null until a player record exists.
• username string — Sign-in name.
• displayName string — Name shown to other players.
• fullName string — Full name as entered on the profile.
• email string · optional — Contact email, when one is set.
• golfId string · optional — National golf id, normalised (no separators), when one is set.
• distanceUnit string — Preferred distance unit: `metric` or `imperial`. Stored values are always metres.
• createdAt string (date-time) — When the account was created.
• homeClubs array of MeHomeClub — Home clubs, primary first when one is marked.
• handicapIndex number (double) · optional — Current handicap index, when one is recorded.
• handicapDate string (date) · optional — The date the handicap index was last set.
• gender string · optional — Gender as chosen on the player record, when set.

Errors: 401, 404, 502

Download everything

Your profile, tours, every round with your own scorecard lines, and all-time statistics as one JSON file. Limited to two downloads per minute.

Returns MeExport

• exportedAt string (date-time) — When the export was produced.
• profile MeProfile
• tours array of MeTour — Every tour the user is a member of, finished ones included.
• rounds array of MeRoundDetail — Every round the user has played, with their own scorecard lines.
• statistics MeStatistics

Errors: 401, 404, 429, 502

Your rounds

Every round you have played, newest first, with your totals in each.

Returns array of MeRoundSummary

• roundId string (uuid) — Round id; use it with the round detail route.
• tourId string (uuid) — The tour the round belongs to.
• tourName string — Tour name.
• courseName string — Course name.
• status string — Round status: `open`, `playing`, `finished` or `cancelled`.
• playDate string (date) · optional — Calendar date of play, when the round has one.
• playedAtUtc string (date-time) — When the round was played, UTC.
• holesScored integer (int32) — Holes with a score.
• grossStrokes integer (int32) — Total gross strokes over the scored holes.
• toPar integer (int32) — Gross strokes relative to par over the scored holes.
• meritPoints number (double) — Merit points earned in this round across its games.
• position integer (int32) · optional — Finishing position in the field; null when the round has no leaderboard yet.
• fieldSize integer (int32) — Number of players in the round.

Errors: 401, 404, 502

One of your rounds

The round as the app shows it to you: who played, every player's scorecard lines, hole events and scores, the game scores and the leaderboard. A round you did not play is a 404.

Parameters

• roundId path · string (uuid) · required

Returns MeRoundDetail

• round MeRound
• players array of MePlayer — Everyone who played the round, the caller included, by id and display name.
• holeEntries array of MeHoleEntry — Scorecard lines for every player, one per scored hole. Keyed by `playerId`.
• holeEvents array of MeHoleEvent — Hole events for every player.
• scores array of MeHoleScore — Stored gross scores for every player.
• gameScores array of MeGameScore — Each game's score points, per player.
• leaderboard array of MeRoundStanding — The round leaderboard: game points per player, with the per-game breakdown.

Errors: 401, 404, 502

Your statistics

Rounds, tours, games, trophies and scoring trends for one calendar year, or all time when no year is given.

Parameters

• year query · integer (int32)

Returns MeStatistics

• playerId string (uuid) — The caller's player id.
• year integer (int32) · optional — Calendar year the numbers cover, or null for all time.
• availableYears array — Years the user has rounds in, newest first.
• overview MeStatisticsOverview
• activeTours array of MeStatisticsTour — Tours the user is in that have not finished.
• trophies MeStatisticsTrophies
• games array of MeStatisticsGame — Game types played in the period, with wins.
• recentRounds array of MeRoundSummary — The most recent rounds in the period.
• scoring MeStatisticsScoring

Errors: 401, 404, 502

Your tours

Every tour you are a member of, hidden and finished ones included, each with the players in it.

Returns array of MeTour

• id string (uuid) — Tour id.
• tourName string · optional — Tour name, when one was given.
• status string — Tour status: `active`, `finished` or `archived`.
• isHidden boolean — True when the user hid the tour from their own tour list.
• unfinishedRoundCount integer (int32) — Rounds in the tour that have not finished.
• createdAt string (date-time) — When the tour was created.
• playerCount integer (int32) — How many players are in the tour, the caller included.
• players array of MePlayer — The players in the tour, the caller included, by id and display name.

Errors: 401, 404, 502

One of your tours

The tour, the players in it, and the merit standings. A tour you are not in is a 404.

Parameters

• tourId path · string (uuid) · required

Returns MeTourDetail

• tour MeTour
• leaderboard array of MeTourStanding — The merit standings, highest first. Empty until a round has been scored.

Errors: 401, 404, 502