Overview
Welcome to the Wingfield Partner API docs.
API conventions
Forward compatibility
We may add new fields to any response at any time. Your client must ignore fields it does not know. We never remove or rename documented fields without notice.
Absent fields vs. null values
Stat-carrying responses (for example session details) come in sport-specific shapes:
- A field that is absent from a shape does not apply to that sport. For
example, pickleball has no second serve, so pickleball sessions carry no
numSecondServesfield. - A field that is present with value
nullapplies to the sport, but was not measured for that particular session (for example, older recordings).
A documented field of a shape is always present in the response — it is never omitted just because its value is unknown.
Guides
Authentication
Learn how to authenticate using API tokens and understand the associated scopes and permissions.
Error Handling
Learn how errors are structured and how to handle them effectively in your integration.
Pagination
Learn how lists of resources are returned.
External Service
Learn about the concept of external services and their IDs.