For the complete documentation index, see llms.txt. This page is also available as Markdown.

Areas

Specific locations within a region, such as buildings or outdoor sections.

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
items._links.availableCoaches.startTimestring · date-timeOptional

If not set, defaults to now

Example: 2021-09-08T00:00:00Z
items._links.availableCoaches.endTimestring · date-timeOptional

If not set, the response will include up to 1 day ahead since startTime

expandstring[]OptionalExample: ["items._links.availableCoaches"]
items._links.availableCoaches.coachIdstring[]OptionalExample: ["d94320d9-a8f7-4d3d-92ae-3ef7a6285a5a"]
areaIdstring[]OptionalExample: ["les","w37"]
Responses
200

Returns a AreaCollection

application/json
_totalnumberRequired
get/areas
GET /apis/v2/areas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Returns a AreaCollection

{
  "items": [
    {
      "id": "text",
      "slug": "text",
      "displayName": "text",
      "displayNameShort": "text",
      "status": "NOT_AVAILABLE",
      "comingSoonText": "text",
      "address": {
        "street": "text",
        "city": "text",
        "borough": "text",
        "zip": "text",
        "displayName": "text",
        "coordinates": {
          "latitude": 1,
          "longitude": 1
        }
      },
      "pods": {
        "items": [
          {
            "id": "text",
            "slug": "text",
            "displayName": "text",
            "displayNameShort": "text",
            "description": "text",
            "address": {
              "street": "text",
              "floor": "text",
              "city": "text",
              "zip": "text",
              "displayName": "text"
            },
            "timezone": "text",
            "type": "PRIVATE",
            "status": "NOT_AVAILABLE",
            "sport": "PICKLEBALL",
            "area": {},
            "tables": {
              "items": [
                {
                  "id": "text",
                  "slug": "text",
                  "displayName": "text",
                  "displayNameShort": "text",
                  "description": "text",
                  "type": "STANDARD",
                  "status": "AVAILABLE",
                  "features": [
                    "REPLAYS"
                  ],
                  "pod": {},
                  "settings": {
                    "items": [
                      {
                        "id": "text",
                        "value": {}
                      }
                    ],
                    "_total": 1,
                    "_links": {
                      "self": {
                        "href": "text"
                      }
                    }
                  },
                  "errors": [
                    {
                      "code": "text",
                      "message": "text",
                      "details": {}
                    }
                  ],
                  "_links": {}
                }
              ],
              "_total": 1,
              "_links": {
                "self": {
                  "href": "text"
                }
              }
            },
            "openTime": {
              "hours": 1,
              "minutes": 1
            },
            "closeTime": {
              "hours": 1,
              "minutes": 1
            },
            "closedTimeOverrides": {
              "items": [
                {
                  "id": "text",
                  "days": [
                    1
                  ],
                  "from": {
                    "hours": 1,
                    "minutes": 1
                  },
                  "to": {
                    "hours": 1,
                    "minutes": 1
                  }
                }
              ],
              "_total": 1,
              "_links": {
                "self": {
                  "href": "text"
                }
              }
            },
            "guests": {
              "private": {
                "min": "text",
                "max": "text"
              }
            },
            "rates": {},
            "settings": {
              "items": [
                {
                  "id": "text",
                  "value": {}
                }
              ],
              "_total": 1,
              "_links": {
                "self": {
                  "href": "text"
                }
              }
            },
            "errors": [
              {
                "code": "text",
                "message": "text",
                "details": {}
              }
            ],
            "_links": {}
          }
        ],
        "_total": 1,
        "_links": {
          "self": {
            "href": "text"
          }
        }
      },
      "availableCoaches": {
        "items": [
          {
            "id": "text",
            "status": "AVAILABLE",
            "startTime": "2026-01-01T00:00:00.000Z",
            "endTime": "2026-01-01T00:00:00.000Z",
            "area": {
              "id": "text"
            },
            "coach": {
              "id": "text",
              "user": {
                "id": "text"
              },
              "type": "REGULAR",
              "firstName": "text",
              "lastName": "text",
              "gender": "text",
              "birthday": "2026-01-01T00:00:00.000Z",
              "initials": "text",
              "description": "text",
              "picture": {},
              "usattRating": 1,
              "duprProfileUrl": "text",
              "memberSince": "2026-01-01T00:00:00.000Z",
              "membershipEnrollment": {},
              "kids": {},
              "_links": {},
              "settings": {
                "id": "text"
              },
              "tierSettings": {
                "id": "text"
              },
              "rateSettings": {
                "guests": 1,
                "hourlyRate": 1
              },
              "fullName": "text",
              "students": {
                "_total": 1
              },
              "slug": "text",
              "coachType": "ROBOT"
            },
            "_links": {}
          }
        ],
        "_total": 1,
        "_links": {
          "self": {
            "href": "text"
          }
        }
      },
      "picture": {
        "id": "text",
        "small": {
          "href": "text"
        },
        "medium": {
          "href": "text"
        },
        "large": {
          "href": "text"
        },
        "_links": {
          "self": {
            "href": "text"
          }
        }
      },
      "region": {
        "id": "text",
        "slug": "text",
        "displayName": "text",
        "picture": {
          "id": "text"
        },
        "taxSettings": [
          "text"
        ],
        "settings": {
          "items": [
            {
              "id": "text",
              "value": {}
            }
          ],
          "_total": 1,
          "_links": {}
        },
        "errors": [
          {
            "code": "text",
            "message": "text",
            "details": {}
          }
        ],
        "_links": {}
      },
      "settings": {
        "items": [
          {
            "id": "area.timezone",
            "value": {}
          }
        ],
        "_total": 1,
        "_links": {
          "self": {
            "href": "text"
          }
        }
      },
      "replaysPricing": {
        "quickReplay": {
          "enabled": true,
          "lengthSeconds": 1,
          "price": 1,
          "initialFree": 1
        },
        "customReplay": {
          "enabled": true,
          "minDurationSeconds": 1,
          "maxDurationSeconds": 1,
          "maxDaysToRequest": 1,
          "pricingIntervals": [
            {
              "minDurationSeconds": 1,
              "maxDurationSeconds": 1,
              "price": 1
            }
          ],
          "pricePerMinute": 1
        },
        "enhancedReplay": {
          "enabled": true,
          "pricePerMinute": 1
        }
      },
      "errors": [
        {
          "code": "text",
          "message": "text",
          "details": {}
        }
      ],
      "_links": {}
    }
  ],
  "_total": 1,
  "_links": {
    "self": {
      "href": "text"
    }
  }
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringRequired
slugstringRequired
displayNamestringRequired
displayNameShortstringRequired
statusstring · enumRequiredPossible values:
comingSoonTextstringOptional

Custom text to display when status is COMING_SOON (max 40 chars)

_linksobjectRequired
Responses
201

Returns an Area

application/json
idstringRequired
slugstringRequired
displayNamestringRequired
displayNameShortstringRequired
statusstring · enumRequiredPossible values:
comingSoonTextstringOptional

Custom text to display when status is COMING_SOON (max 40 chars)

_linksobjectRequired
post/areas
POST /apis/v2/areas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2444

{
  "id": "text",
  "slug": "text",
  "displayName": "text",
  "displayNameShort": "text",
  "status": "NOT_AVAILABLE",
  "comingSoonText": "text",
  "address": {
    "street": "text",
    "city": "text",
    "borough": "text",
    "zip": "text",
    "displayName": "text",
    "coordinates": {
      "latitude": 1,
      "longitude": 1
    }
  },
  "pods": {
    "items": [
      {
        "id": "text",
        "slug": "text",
        "displayName": "text",
        "displayNameShort": "text",
        "description": "text",
        "address": {
          "street": "text",
          "floor": "text",
          "city": "text",
          "zip": "text",
          "displayName": "text"
        },
        "timezone": "text",
        "type": "PRIVATE",
        "status": "NOT_AVAILABLE",
        "sport": "PICKLEBALL",
        "area": {},
        "tables": {
          "items": [
            {
              "id": "text",
              "slug": "text",
              "displayName": "text",
              "displayNameShort": "text",
              "description": "text",
              "type": "STANDARD",
              "status": "AVAILABLE",
              "features": [
                "REPLAYS"
              ],
              "pod": {},
              "settings": {
                "items": [
                  {
                    "value": {}
                  }
                ],
                "_total": 1,
                "_links": {
                  "self": {
                    "href": "text"
                  }
                }
              },
              "_links": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "openTime": {
          "hours": 1,
          "minutes": 1
        },
        "closeTime": {
          "hours": 1,
          "minutes": 1
        },
        "closedTimeOverrides": {
          "items": [
            {
              "days": [
                1
              ],
              "from": {
                "hours": 1,
                "minutes": 1
              },
              "to": {
                "hours": 1,
                "minutes": 1
              }
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "guests": {
          "private": {
            "min": "text",
            "max": "text"
          }
        },
        "rates": {},
        "settings": {
          "items": [
            {
              "value": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "availableCoaches": {
    "items": [
      {
        "id": "text",
        "status": "AVAILABLE",
        "startTime": "2026-01-01T00:00:00.000Z",
        "endTime": "2026-01-01T00:00:00.000Z",
        "area": {
          "id": "text"
        },
        "coach": {
          "id": "text",
          "user": {
            "id": "text"
          },
          "description": "text",
          "_links": {},
          "settings": {
            "id": "text"
          },
          "fullName": "text",
          "students": {
            "_total": 1
          },
          "slug": "text",
          "coachType": "ROBOT"
        },
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "picture": {
    "id": "text",
    "small": {
      "href": "text"
    },
    "medium": {
      "href": "text"
    },
    "large": {
      "href": "text"
    },
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "region": {
    "id": "text",
    "slug": "text",
    "displayName": "text",
    "picture": {
      "id": "text"
    },
    "taxSettings": [
      "text"
    ],
    "settings": {
      "items": [
        {
          "value": {}
        }
      ],
      "_total": 1,
      "_links": {}
    },
    "_links": {}
  },
  "settings": {
    "items": [
      {
        "value": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "replaysPricing": {
    "quickReplay": {
      "enabled": true,
      "lengthSeconds": 1,
      "price": 1,
      "initialFree": 1
    },
    "customReplay": {
      "enabled": true,
      "minDurationSeconds": 1,
      "maxDurationSeconds": 1,
      "maxDaysToRequest": 1,
      "pricingIntervals": [
        {
          "minDurationSeconds": 1,
          "maxDurationSeconds": 1,
          "price": 1
        }
      ],
      "pricePerMinute": 1
    },
    "enhancedReplay": {
      "enabled": true,
      "pricePerMinute": 1
    }
  },
  "_links": {}
}
201

Returns an Area

{
  "id": "text",
  "slug": "text",
  "displayName": "text",
  "displayNameShort": "text",
  "status": "NOT_AVAILABLE",
  "comingSoonText": "text",
  "address": {
    "street": "text",
    "city": "text",
    "borough": "text",
    "zip": "text",
    "displayName": "text",
    "coordinates": {
      "latitude": 1,
      "longitude": 1
    }
  },
  "pods": {
    "items": [
      {
        "id": "text",
        "slug": "text",
        "displayName": "text",
        "displayNameShort": "text",
        "description": "text",
        "address": {
          "street": "text",
          "floor": "text",
          "city": "text",
          "zip": "text",
          "displayName": "text"
        },
        "timezone": "text",
        "type": "PRIVATE",
        "status": "NOT_AVAILABLE",
        "sport": "PICKLEBALL",
        "area": {},
        "tables": {
          "items": [
            {
              "id": "text",
              "slug": "text",
              "displayName": "text",
              "displayNameShort": "text",
              "description": "text",
              "type": "STANDARD",
              "status": "AVAILABLE",
              "features": [
                "REPLAYS"
              ],
              "pod": {},
              "settings": {
                "items": [
                  {
                    "id": "text",
                    "value": {}
                  }
                ],
                "_total": 1,
                "_links": {
                  "self": {
                    "href": "text"
                  }
                }
              },
              "errors": [
                {
                  "code": "text",
                  "message": "text",
                  "details": {}
                }
              ],
              "_links": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "openTime": {
          "hours": 1,
          "minutes": 1
        },
        "closeTime": {
          "hours": 1,
          "minutes": 1
        },
        "closedTimeOverrides": {
          "items": [
            {
              "id": "text",
              "days": [
                1
              ],
              "from": {
                "hours": 1,
                "minutes": 1
              },
              "to": {
                "hours": 1,
                "minutes": 1
              }
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "guests": {
          "private": {
            "min": "text",
            "max": "text"
          }
        },
        "rates": {},
        "settings": {
          "items": [
            {
              "id": "text",
              "value": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "errors": [
          {
            "code": "text",
            "message": "text",
            "details": {}
          }
        ],
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "availableCoaches": {
    "items": [
      {
        "id": "text",
        "status": "AVAILABLE",
        "startTime": "2026-01-01T00:00:00.000Z",
        "endTime": "2026-01-01T00:00:00.000Z",
        "area": {
          "id": "text"
        },
        "coach": {
          "id": "text",
          "user": {
            "id": "text"
          },
          "type": "REGULAR",
          "firstName": "text",
          "lastName": "text",
          "gender": "text",
          "birthday": "2026-01-01T00:00:00.000Z",
          "initials": "text",
          "description": "text",
          "picture": {},
          "usattRating": 1,
          "duprProfileUrl": "text",
          "memberSince": "2026-01-01T00:00:00.000Z",
          "membershipEnrollment": {},
          "kids": {},
          "_links": {},
          "settings": {
            "id": "text"
          },
          "tierSettings": {
            "id": "text"
          },
          "rateSettings": {
            "guests": 1,
            "hourlyRate": 1
          },
          "fullName": "text",
          "students": {
            "_total": 1
          },
          "slug": "text",
          "coachType": "ROBOT"
        },
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "picture": {
    "id": "text",
    "small": {
      "href": "text"
    },
    "medium": {
      "href": "text"
    },
    "large": {
      "href": "text"
    },
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "region": {
    "id": "text",
    "slug": "text",
    "displayName": "text",
    "picture": {
      "id": "text"
    },
    "taxSettings": [
      "text"
    ],
    "settings": {
      "items": [
        {
          "id": "text",
          "value": {}
        }
      ],
      "_total": 1,
      "_links": {}
    },
    "errors": [
      {
        "code": "text",
        "message": "text",
        "details": {}
      }
    ],
    "_links": {}
  },
  "settings": {
    "items": [
      {
        "id": "area.timezone",
        "value": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "replaysPricing": {
    "quickReplay": {
      "enabled": true,
      "lengthSeconds": 1,
      "price": 1,
      "initialFree": 1
    },
    "customReplay": {
      "enabled": true,
      "minDurationSeconds": 1,
      "maxDurationSeconds": 1,
      "maxDaysToRequest": 1,
      "pricingIntervals": [
        {
          "minDurationSeconds": 1,
          "maxDurationSeconds": 1,
          "price": 1
        }
      ],
      "pricePerMinute": 1
    },
    "enhancedReplay": {
      "enabled": true,
      "pricePerMinute": 1
    }
  },
  "errors": [
    {
      "code": "text",
      "message": "text",
      "details": {}
    }
  ],
  "_links": {}
}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
expandstring[]Optional
Responses
200

Returns a Area

application/json
idstringRequired
slugstringRequired
displayNamestringRequired
displayNameShortstringRequired
statusstring · enumRequiredPossible values:
comingSoonTextstringOptional

Custom text to display when status is COMING_SOON (max 40 chars)

_linksobjectRequired
get/areas/closest
GET /apis/v2/areas/closest HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "text",
  "slug": "text",
  "displayName": "text",
  "displayNameShort": "text",
  "status": "NOT_AVAILABLE",
  "comingSoonText": "text",
  "address": {
    "street": "text",
    "city": "text",
    "borough": "text",
    "zip": "text",
    "displayName": "text",
    "coordinates": {
      "latitude": 1,
      "longitude": 1
    }
  },
  "pods": {
    "items": [
      {
        "id": "text",
        "slug": "text",
        "displayName": "text",
        "displayNameShort": "text",
        "description": "text",
        "address": {
          "street": "text",
          "floor": "text",
          "city": "text",
          "zip": "text",
          "displayName": "text"
        },
        "timezone": "text",
        "type": "PRIVATE",
        "status": "NOT_AVAILABLE",
        "sport": "PICKLEBALL",
        "area": {},
        "tables": {
          "items": [
            {
              "id": "text",
              "slug": "text",
              "displayName": "text",
              "displayNameShort": "text",
              "description": "text",
              "type": "STANDARD",
              "status": "AVAILABLE",
              "features": [
                "REPLAYS"
              ],
              "pod": {},
              "settings": {
                "items": [
                  {
                    "id": "text",
                    "value": {}
                  }
                ],
                "_total": 1,
                "_links": {
                  "self": {
                    "href": "text"
                  }
                }
              },
              "errors": [
                {
                  "code": "text",
                  "message": "text",
                  "details": {}
                }
              ],
              "_links": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "openTime": {
          "hours": 1,
          "minutes": 1
        },
        "closeTime": {
          "hours": 1,
          "minutes": 1
        },
        "closedTimeOverrides": {
          "items": [
            {
              "id": "text",
              "days": [
                1
              ],
              "from": {
                "hours": 1,
                "minutes": 1
              },
              "to": {
                "hours": 1,
                "minutes": 1
              }
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "guests": {
          "private": {
            "min": "text",
            "max": "text"
          }
        },
        "rates": {},
        "settings": {
          "items": [
            {
              "id": "text",
              "value": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "errors": [
          {
            "code": "text",
            "message": "text",
            "details": {}
          }
        ],
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "availableCoaches": {
    "items": [
      {
        "id": "text",
        "status": "AVAILABLE",
        "startTime": "2026-01-01T00:00:00.000Z",
        "endTime": "2026-01-01T00:00:00.000Z",
        "area": {
          "id": "text"
        },
        "coach": {
          "id": "text",
          "user": {
            "id": "text"
          },
          "type": "REGULAR",
          "firstName": "text",
          "lastName": "text",
          "gender": "text",
          "birthday": "2026-01-01T00:00:00.000Z",
          "initials": "text",
          "description": "text",
          "picture": {},
          "usattRating": 1,
          "duprProfileUrl": "text",
          "memberSince": "2026-01-01T00:00:00.000Z",
          "membershipEnrollment": {},
          "kids": {},
          "_links": {},
          "settings": {
            "id": "text"
          },
          "tierSettings": {
            "id": "text"
          },
          "rateSettings": {
            "guests": 1,
            "hourlyRate": 1
          },
          "fullName": "text",
          "students": {
            "_total": 1
          },
          "slug": "text",
          "coachType": "ROBOT"
        },
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "picture": {
    "id": "text",
    "small": {
      "href": "text"
    },
    "medium": {
      "href": "text"
    },
    "large": {
      "href": "text"
    },
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "region": {
    "id": "text",
    "slug": "text",
    "displayName": "text",
    "picture": {
      "id": "text"
    },
    "taxSettings": [
      "text"
    ],
    "settings": {
      "items": [
        {
          "id": "text",
          "value": {}
        }
      ],
      "_total": 1,
      "_links": {}
    },
    "errors": [
      {
        "code": "text",
        "message": "text",
        "details": {}
      }
    ],
    "_links": {}
  },
  "settings": {
    "items": [
      {
        "id": "area.timezone",
        "value": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "replaysPricing": {
    "quickReplay": {
      "enabled": true,
      "lengthSeconds": 1,
      "price": 1,
      "initialFree": 1
    },
    "customReplay": {
      "enabled": true,
      "minDurationSeconds": 1,
      "maxDurationSeconds": 1,
      "maxDaysToRequest": 1,
      "pricingIntervals": [
        {
          "minDurationSeconds": 1,
          "maxDurationSeconds": 1,
          "price": 1
        }
      ],
      "pricePerMinute": 1
    },
    "enhancedReplay": {
      "enabled": true,
      "pricePerMinute": 1
    }
  },
  "errors": [
    {
      "code": "text",
      "message": "text",
      "details": {}
    }
  ],
  "_links": {}
}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
areaIdstringRequiredExample: w37
Query parameters
expandstring[]OptionalExample: ["_links.availableCoaches","_links.replaysPricing"]
Responses
200

Returns an Area

application/json
idstringRequired
slugstringRequired
displayNamestringRequired
displayNameShortstringRequired
statusstring · enumRequiredPossible values:
comingSoonTextstringOptional

Custom text to display when status is COMING_SOON (max 40 chars)

_linksobjectRequired
get/areas/{areaId}
GET /apis/v2/areas/{areaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Returns an Area

{
  "id": "text",
  "slug": "text",
  "displayName": "text",
  "displayNameShort": "text",
  "status": "NOT_AVAILABLE",
  "comingSoonText": "text",
  "address": {
    "street": "text",
    "city": "text",
    "borough": "text",
    "zip": "text",
    "displayName": "text",
    "coordinates": {
      "latitude": 1,
      "longitude": 1
    }
  },
  "pods": {
    "items": [
      {
        "id": "text",
        "slug": "text",
        "displayName": "text",
        "displayNameShort": "text",
        "description": "text",
        "address": {
          "street": "text",
          "floor": "text",
          "city": "text",
          "zip": "text",
          "displayName": "text"
        },
        "timezone": "text",
        "type": "PRIVATE",
        "status": "NOT_AVAILABLE",
        "sport": "PICKLEBALL",
        "area": {},
        "tables": {
          "items": [
            {
              "id": "text",
              "slug": "text",
              "displayName": "text",
              "displayNameShort": "text",
              "description": "text",
              "type": "STANDARD",
              "status": "AVAILABLE",
              "features": [
                "REPLAYS"
              ],
              "pod": {},
              "settings": {
                "items": [
                  {
                    "id": "text",
                    "value": {}
                  }
                ],
                "_total": 1,
                "_links": {
                  "self": {
                    "href": "text"
                  }
                }
              },
              "errors": [
                {
                  "code": "text",
                  "message": "text",
                  "details": {}
                }
              ],
              "_links": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "openTime": {
          "hours": 1,
          "minutes": 1
        },
        "closeTime": {
          "hours": 1,
          "minutes": 1
        },
        "closedTimeOverrides": {
          "items": [
            {
              "id": "text",
              "days": [
                1
              ],
              "from": {
                "hours": 1,
                "minutes": 1
              },
              "to": {
                "hours": 1,
                "minutes": 1
              }
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "guests": {
          "private": {
            "min": "text",
            "max": "text"
          }
        },
        "rates": {},
        "settings": {
          "items": [
            {
              "id": "text",
              "value": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "errors": [
          {
            "code": "text",
            "message": "text",
            "details": {}
          }
        ],
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "availableCoaches": {
    "items": [
      {
        "id": "text",
        "status": "AVAILABLE",
        "startTime": "2026-01-01T00:00:00.000Z",
        "endTime": "2026-01-01T00:00:00.000Z",
        "area": {
          "id": "text"
        },
        "coach": {
          "id": "text",
          "user": {
            "id": "text"
          },
          "type": "REGULAR",
          "firstName": "text",
          "lastName": "text",
          "gender": "text",
          "birthday": "2026-01-01T00:00:00.000Z",
          "initials": "text",
          "description": "text",
          "picture": {},
          "usattRating": 1,
          "duprProfileUrl": "text",
          "memberSince": "2026-01-01T00:00:00.000Z",
          "membershipEnrollment": {},
          "kids": {},
          "_links": {},
          "settings": {
            "id": "text"
          },
          "tierSettings": {
            "id": "text"
          },
          "rateSettings": {
            "guests": 1,
            "hourlyRate": 1
          },
          "fullName": "text",
          "students": {
            "_total": 1
          },
          "slug": "text",
          "coachType": "ROBOT"
        },
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "picture": {
    "id": "text",
    "small": {
      "href": "text"
    },
    "medium": {
      "href": "text"
    },
    "large": {
      "href": "text"
    },
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "region": {
    "id": "text",
    "slug": "text",
    "displayName": "text",
    "picture": {
      "id": "text"
    },
    "taxSettings": [
      "text"
    ],
    "settings": {
      "items": [
        {
          "id": "text",
          "value": {}
        }
      ],
      "_total": 1,
      "_links": {}
    },
    "errors": [
      {
        "code": "text",
        "message": "text",
        "details": {}
      }
    ],
    "_links": {}
  },
  "settings": {
    "items": [
      {
        "id": "area.timezone",
        "value": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "replaysPricing": {
    "quickReplay": {
      "enabled": true,
      "lengthSeconds": 1,
      "price": 1,
      "initialFree": 1
    },
    "customReplay": {
      "enabled": true,
      "minDurationSeconds": 1,
      "maxDurationSeconds": 1,
      "maxDaysToRequest": 1,
      "pricingIntervals": [
        {
          "minDurationSeconds": 1,
          "maxDurationSeconds": 1,
          "price": 1
        }
      ],
      "pricePerMinute": 1
    },
    "enhancedReplay": {
      "enabled": true,
      "pricePerMinute": 1
    }
  },
  "errors": [
    {
      "code": "text",
      "message": "text",
      "details": {}
    }
  ],
  "_links": {}
}
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
areaIdstringRequiredExample: w37
Query parameters
expandstring[]OptionalExample: ["_links.availableCoaches"]
Responses
200

Returns an Area

application/json
idstringRequired
slugstringRequired
displayNamestringRequired
displayNameShortstringRequired
statusstring · enumRequiredPossible values:
comingSoonTextstringOptional

Custom text to display when status is COMING_SOON (max 40 chars)

_linksobjectRequired
delete/areas/{areaId}
DELETE /apis/v2/areas/{areaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Returns an Area

{
  "id": "text",
  "slug": "text",
  "displayName": "text",
  "displayNameShort": "text",
  "status": "NOT_AVAILABLE",
  "comingSoonText": "text",
  "address": {
    "street": "text",
    "city": "text",
    "borough": "text",
    "zip": "text",
    "displayName": "text",
    "coordinates": {
      "latitude": 1,
      "longitude": 1
    }
  },
  "pods": {
    "items": [
      {
        "id": "text",
        "slug": "text",
        "displayName": "text",
        "displayNameShort": "text",
        "description": "text",
        "address": {
          "street": "text",
          "floor": "text",
          "city": "text",
          "zip": "text",
          "displayName": "text"
        },
        "timezone": "text",
        "type": "PRIVATE",
        "status": "NOT_AVAILABLE",
        "sport": "PICKLEBALL",
        "area": {},
        "tables": {
          "items": [
            {
              "id": "text",
              "slug": "text",
              "displayName": "text",
              "displayNameShort": "text",
              "description": "text",
              "type": "STANDARD",
              "status": "AVAILABLE",
              "features": [
                "REPLAYS"
              ],
              "pod": {},
              "settings": {
                "items": [
                  {
                    "id": "text",
                    "value": {}
                  }
                ],
                "_total": 1,
                "_links": {
                  "self": {
                    "href": "text"
                  }
                }
              },
              "errors": [
                {
                  "code": "text",
                  "message": "text",
                  "details": {}
                }
              ],
              "_links": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "openTime": {
          "hours": 1,
          "minutes": 1
        },
        "closeTime": {
          "hours": 1,
          "minutes": 1
        },
        "closedTimeOverrides": {
          "items": [
            {
              "id": "text",
              "days": [
                1
              ],
              "from": {
                "hours": 1,
                "minutes": 1
              },
              "to": {
                "hours": 1,
                "minutes": 1
              }
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "guests": {
          "private": {
            "min": "text",
            "max": "text"
          }
        },
        "rates": {},
        "settings": {
          "items": [
            {
              "id": "text",
              "value": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "errors": [
          {
            "code": "text",
            "message": "text",
            "details": {}
          }
        ],
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "availableCoaches": {
    "items": [
      {
        "id": "text",
        "status": "AVAILABLE",
        "startTime": "2026-01-01T00:00:00.000Z",
        "endTime": "2026-01-01T00:00:00.000Z",
        "area": {
          "id": "text"
        },
        "coach": {
          "id": "text",
          "user": {
            "id": "text"
          },
          "type": "REGULAR",
          "firstName": "text",
          "lastName": "text",
          "gender": "text",
          "birthday": "2026-01-01T00:00:00.000Z",
          "initials": "text",
          "description": "text",
          "picture": {},
          "usattRating": 1,
          "duprProfileUrl": "text",
          "memberSince": "2026-01-01T00:00:00.000Z",
          "membershipEnrollment": {},
          "kids": {},
          "_links": {},
          "settings": {
            "id": "text"
          },
          "tierSettings": {
            "id": "text"
          },
          "rateSettings": {
            "guests": 1,
            "hourlyRate": 1
          },
          "fullName": "text",
          "students": {
            "_total": 1
          },
          "slug": "text",
          "coachType": "ROBOT"
        },
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "picture": {
    "id": "text",
    "small": {
      "href": "text"
    },
    "medium": {
      "href": "text"
    },
    "large": {
      "href": "text"
    },
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "region": {
    "id": "text",
    "slug": "text",
    "displayName": "text",
    "picture": {
      "id": "text"
    },
    "taxSettings": [
      "text"
    ],
    "settings": {
      "items": [
        {
          "id": "text",
          "value": {}
        }
      ],
      "_total": 1,
      "_links": {}
    },
    "errors": [
      {
        "code": "text",
        "message": "text",
        "details": {}
      }
    ],
    "_links": {}
  },
  "settings": {
    "items": [
      {
        "id": "area.timezone",
        "value": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "replaysPricing": {
    "quickReplay": {
      "enabled": true,
      "lengthSeconds": 1,
      "price": 1,
      "initialFree": 1
    },
    "customReplay": {
      "enabled": true,
      "minDurationSeconds": 1,
      "maxDurationSeconds": 1,
      "maxDaysToRequest": 1,
      "pricingIntervals": [
        {
          "minDurationSeconds": 1,
          "maxDurationSeconds": 1,
          "price": 1
        }
      ],
      "pricePerMinute": 1
    },
    "enhancedReplay": {
      "enabled": true,
      "pricePerMinute": 1
    }
  },
  "errors": [
    {
      "code": "text",
      "message": "text",
      "details": {}
    }
  ],
  "_links": {}
}
patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
areaIdstringRequiredExample: w37
Body
idstringRequired
slugstringRequired
displayNamestringRequired
displayNameShortstringRequired
statusstring · enumRequiredPossible values:
comingSoonTextstringOptional

Custom text to display when status is COMING_SOON (max 40 chars)

_linksobjectRequired
Responses
200

Returns an Area

application/json
idstringRequired
slugstringRequired
displayNamestringRequired
displayNameShortstringRequired
statusstring · enumRequiredPossible values:
comingSoonTextstringOptional

Custom text to display when status is COMING_SOON (max 40 chars)

_linksobjectRequired
patch/areas/{areaId}
PATCH /apis/v2/areas/{areaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2444

{
  "id": "text",
  "slug": "text",
  "displayName": "text",
  "displayNameShort": "text",
  "status": "NOT_AVAILABLE",
  "comingSoonText": "text",
  "address": {
    "street": "text",
    "city": "text",
    "borough": "text",
    "zip": "text",
    "displayName": "text",
    "coordinates": {
      "latitude": 1,
      "longitude": 1
    }
  },
  "pods": {
    "items": [
      {
        "id": "text",
        "slug": "text",
        "displayName": "text",
        "displayNameShort": "text",
        "description": "text",
        "address": {
          "street": "text",
          "floor": "text",
          "city": "text",
          "zip": "text",
          "displayName": "text"
        },
        "timezone": "text",
        "type": "PRIVATE",
        "status": "NOT_AVAILABLE",
        "sport": "PICKLEBALL",
        "area": {},
        "tables": {
          "items": [
            {
              "id": "text",
              "slug": "text",
              "displayName": "text",
              "displayNameShort": "text",
              "description": "text",
              "type": "STANDARD",
              "status": "AVAILABLE",
              "features": [
                "REPLAYS"
              ],
              "pod": {},
              "settings": {
                "items": [
                  {
                    "value": {}
                  }
                ],
                "_total": 1,
                "_links": {
                  "self": {
                    "href": "text"
                  }
                }
              },
              "_links": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "openTime": {
          "hours": 1,
          "minutes": 1
        },
        "closeTime": {
          "hours": 1,
          "minutes": 1
        },
        "closedTimeOverrides": {
          "items": [
            {
              "days": [
                1
              ],
              "from": {
                "hours": 1,
                "minutes": 1
              },
              "to": {
                "hours": 1,
                "minutes": 1
              }
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "guests": {
          "private": {
            "min": "text",
            "max": "text"
          }
        },
        "rates": {},
        "settings": {
          "items": [
            {
              "value": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "availableCoaches": {
    "items": [
      {
        "id": "text",
        "status": "AVAILABLE",
        "startTime": "2026-01-01T00:00:00.000Z",
        "endTime": "2026-01-01T00:00:00.000Z",
        "area": {
          "id": "text"
        },
        "coach": {
          "id": "text",
          "user": {
            "id": "text"
          },
          "description": "text",
          "_links": {},
          "settings": {
            "id": "text"
          },
          "fullName": "text",
          "students": {
            "_total": 1
          },
          "slug": "text",
          "coachType": "ROBOT"
        },
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "picture": {
    "id": "text",
    "small": {
      "href": "text"
    },
    "medium": {
      "href": "text"
    },
    "large": {
      "href": "text"
    },
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "region": {
    "id": "text",
    "slug": "text",
    "displayName": "text",
    "picture": {
      "id": "text"
    },
    "taxSettings": [
      "text"
    ],
    "settings": {
      "items": [
        {
          "value": {}
        }
      ],
      "_total": 1,
      "_links": {}
    },
    "_links": {}
  },
  "settings": {
    "items": [
      {
        "value": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "replaysPricing": {
    "quickReplay": {
      "enabled": true,
      "lengthSeconds": 1,
      "price": 1,
      "initialFree": 1
    },
    "customReplay": {
      "enabled": true,
      "minDurationSeconds": 1,
      "maxDurationSeconds": 1,
      "maxDaysToRequest": 1,
      "pricingIntervals": [
        {
          "minDurationSeconds": 1,
          "maxDurationSeconds": 1,
          "price": 1
        }
      ],
      "pricePerMinute": 1
    },
    "enhancedReplay": {
      "enabled": true,
      "pricePerMinute": 1
    }
  },
  "_links": {}
}
{
  "id": "text",
  "slug": "text",
  "displayName": "text",
  "displayNameShort": "text",
  "status": "NOT_AVAILABLE",
  "comingSoonText": "text",
  "address": {
    "street": "text",
    "city": "text",
    "borough": "text",
    "zip": "text",
    "displayName": "text",
    "coordinates": {
      "latitude": 1,
      "longitude": 1
    }
  },
  "pods": {
    "items": [
      {
        "id": "text",
        "slug": "text",
        "displayName": "text",
        "displayNameShort": "text",
        "description": "text",
        "address": {
          "street": "text",
          "floor": "text",
          "city": "text",
          "zip": "text",
          "displayName": "text"
        },
        "timezone": "text",
        "type": "PRIVATE",
        "status": "NOT_AVAILABLE",
        "sport": "PICKLEBALL",
        "area": {},
        "tables": {
          "items": [
            {
              "id": "text",
              "slug": "text",
              "displayName": "text",
              "displayNameShort": "text",
              "description": "text",
              "type": "STANDARD",
              "status": "AVAILABLE",
              "features": [
                "REPLAYS"
              ],
              "pod": {},
              "settings": {
                "items": [
                  {
                    "id": "text",
                    "value": {}
                  }
                ],
                "_total": 1,
                "_links": {
                  "self": {
                    "href": "text"
                  }
                }
              },
              "errors": [
                {
                  "code": "text",
                  "message": "text",
                  "details": {}
                }
              ],
              "_links": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "openTime": {
          "hours": 1,
          "minutes": 1
        },
        "closeTime": {
          "hours": 1,
          "minutes": 1
        },
        "closedTimeOverrides": {
          "items": [
            {
              "id": "text",
              "days": [
                1
              ],
              "from": {
                "hours": 1,
                "minutes": 1
              },
              "to": {
                "hours": 1,
                "minutes": 1
              }
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "guests": {
          "private": {
            "min": "text",
            "max": "text"
          }
        },
        "rates": {},
        "settings": {
          "items": [
            {
              "id": "text",
              "value": {}
            }
          ],
          "_total": 1,
          "_links": {
            "self": {
              "href": "text"
            }
          }
        },
        "errors": [
          {
            "code": "text",
            "message": "text",
            "details": {}
          }
        ],
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "availableCoaches": {
    "items": [
      {
        "id": "text",
        "status": "AVAILABLE",
        "startTime": "2026-01-01T00:00:00.000Z",
        "endTime": "2026-01-01T00:00:00.000Z",
        "area": {
          "id": "text"
        },
        "coach": {
          "id": "text",
          "user": {
            "id": "text"
          },
          "type": "REGULAR",
          "firstName": "text",
          "lastName": "text",
          "gender": "text",
          "birthday": "2026-01-01T00:00:00.000Z",
          "initials": "text",
          "description": "text",
          "picture": {},
          "usattRating": 1,
          "duprProfileUrl": "text",
          "memberSince": "2026-01-01T00:00:00.000Z",
          "membershipEnrollment": {},
          "kids": {},
          "_links": {},
          "settings": {
            "id": "text"
          },
          "tierSettings": {
            "id": "text"
          },
          "rateSettings": {
            "guests": 1,
            "hourlyRate": 1
          },
          "fullName": "text",
          "students": {
            "_total": 1
          },
          "slug": "text",
          "coachType": "ROBOT"
        },
        "_links": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "picture": {
    "id": "text",
    "small": {
      "href": "text"
    },
    "medium": {
      "href": "text"
    },
    "large": {
      "href": "text"
    },
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "region": {
    "id": "text",
    "slug": "text",
    "displayName": "text",
    "picture": {
      "id": "text"
    },
    "taxSettings": [
      "text"
    ],
    "settings": {
      "items": [
        {
          "id": "text",
          "value": {}
        }
      ],
      "_total": 1,
      "_links": {}
    },
    "errors": [
      {
        "code": "text",
        "message": "text",
        "details": {}
      }
    ],
    "_links": {}
  },
  "settings": {
    "items": [
      {
        "id": "area.timezone",
        "value": {}
      }
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "replaysPricing": {
    "quickReplay": {
      "enabled": true,
      "lengthSeconds": 1,
      "price": 1,
      "initialFree": 1
    },
    "customReplay": {
      "enabled": true,
      "minDurationSeconds": 1,
      "maxDurationSeconds": 1,
      "maxDaysToRequest": 1,
      "pricingIntervals": [
        {
          "minDurationSeconds": 1,
          "maxDurationSeconds": 1,
          "price": 1
        }
      ],
      "pricePerMinute": 1
    },
    "enhancedReplay": {
      "enabled": true,
      "pricePerMinute": 1
    }
  },
  "errors": [
    {
      "code": "text",
      "message": "text",
      "details": {}
    }
  ],
  "_links": {}
}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
areaIdstringRequiredExample: w37
Query parameters
scopestring[]OptionalExample: ["feature","admin","branding"]
Responses
200

Returns AreaSettings

application/json
_totalnumberRequired
get/areas/{areaId}/settings
GET /apis/v2/areas/{areaId}/settings HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Returns AreaSettings

{
  "items": [
    {
      "id": "area.timezone",
      "value": {}
    }
  ],
  "_total": 1,
  "_links": {
    "self": {
      "href": "text"
    }
  }
}
Deprecated
get

This endpoint is deprecated and will be removed in the future. Please use /areas/:areaId/settings?scope=branding instead.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
areaIdstringRequiredExample: w37
Responses
200

Returns AreaBrandingSettingsCollection

application/json
_totalnumberRequired
get/areas/{areaId}/branding
GET /apis/v2/areas/{areaId}/branding HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Returns AreaBrandingSettingsCollection

{
  "items": [
    {
      "id": "area.membershipHeaderHtml",
      "value": {}
    }
  ],
  "_total": 1,
  "_links": {
    "self": {
      "href": "text"
    }
  }
}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
areaIdstringRequiredExample: w37
Query parameters
expandstring[]OptionalExample: ["items._links.tables"]
Responses
200

Returns a PodCollection

application/json
_totalnumberRequired
get/areas/{areaId}/pods
GET /apis/v2/areas/{areaId}/pods HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Returns a PodCollection

{
  "items": [
    {
      "id": "text",
      "slug": "text",
      "displayName": "text",
      "displayNameShort": "text",
      "description": "text",
      "address": {
        "street": "text",
        "floor": "text",
        "city": "text",
        "zip": "text",
        "displayName": "text"
      },
      "timezone": "text",
      "type": "PRIVATE",
      "status": "NOT_AVAILABLE",
      "sport": "PICKLEBALL",
      "area": {},
      "tables": {
        "items": [
          {
            "id": "text",
            "slug": "text",
            "displayName": "text",
            "displayNameShort": "text",
            "description": "text",
            "type": "STANDARD",
            "status": "AVAILABLE",
            "features": [
              "REPLAYS"
            ],
            "pod": {},
            "settings": {
              "items": [
                {
                  "id": "text",
                  "value": {}
                }
              ],
              "_total": 1,
              "_links": {
                "self": {
                  "href": "text"
                }
              }
            },
            "errors": [
              {
                "code": "text",
                "message": "text",
                "details": {}
              }
            ],
            "_links": {}
          }
        ],
        "_total": 1,
        "_links": {
          "self": {
            "href": "text"
          }
        }
      },
      "openTime": {
        "hours": 1,
        "minutes": 1
      },
      "closeTime": {
        "hours": 1,
        "minutes": 1
      },
      "closedTimeOverrides": {
        "items": [
          {
            "id": "text",
            "days": [
              1
            ],
            "from": {
              "hours": 1,
              "minutes": 1
            },
            "to": {
              "hours": 1,
              "minutes": 1
            }
          }
        ],
        "_total": 1,
        "_links": {
          "self": {
            "href": "text"
          }
        }
      },
      "guests": {
        "private": {
          "min": "text",
          "max": "text"
        }
      },
      "rates": {},
      "settings": {
        "items": [
          {
            "id": "text",
            "value": {}
          }
        ],
        "_total": 1,
        "_links": {
          "self": {
            "href": "text"
          }
        }
      },
      "errors": [
        {
          "code": "text",
          "message": "text",
          "details": {}
        }
      ],
      "_links": {}
    }
  ],
  "_total": 1,
  "_links": {
    "self": {
      "href": "text"
    }
  }
}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
areaIdstringRequiredExample: w37
Query parameters
startTimestring · date-timeOptional

If not set, defaults to now

Example: 2021-09-08T00:00:00Z
endTimestring · date-timeOptional

If not set, the response will include up to 1 day ahead since startTime

expandstring[]Optional
typestring[]OptionalExample: ["HUMAN","ROBOT"]
Responses
200

Returns the Area available CoachProfilees

application/json
_totalnumberRequired
get/areas/{areaId}/available-coaches
GET /apis/v2/areas/{areaId}/available-coaches HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Returns the Area available CoachProfilees

{
  "items": [
    {
      "id": "text",
      "status": "AVAILABLE",
      "startTime": "2026-01-01T00:00:00.000Z",
      "endTime": "2026-01-01T00:00:00.000Z",
      "area": {
        "id": "text"
      },
      "coach": {
        "id": "text",
        "user": {
          "id": "text"
        },
        "type": "REGULAR",
        "firstName": "text",
        "lastName": "text",
        "gender": "text",
        "birthday": "2026-01-01T00:00:00.000Z",
        "initials": "text",
        "description": "text",
        "picture": {},
        "usattRating": 1,
        "duprProfileUrl": "text",
        "memberSince": "2026-01-01T00:00:00.000Z",
        "membershipEnrollment": {},
        "kids": {},
        "_links": {},
        "settings": {
          "id": "text"
        },
        "tierSettings": {
          "id": "text"
        },
        "rateSettings": {
          "guests": 1,
          "hourlyRate": 1
        },
        "fullName": "text",
        "students": {
          "_total": 1
        },
        "slug": "text",
        "coachType": "ROBOT"
      },
      "_links": {}
    }
  ],
  "_total": 1,
  "_links": {
    "self": {
      "href": "text"
    }
  }
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
lockerRoomIdstringRequiredExample: les-locker-room
areaIdstringRequiredExample: les
Body
idstringRequired
typestring · enumRead-onlyRequiredPossible values:
startTimestring · date-timeRead-onlyRequired
endTimestring · date-timeRead-onlyRequired
Responses
200

Returns an AccessDto

application/json
idstringRequired
typestring · enumRead-onlyRequiredPossible values:
startTimestring · date-timeRead-onlyRequired
endTimestring · date-timeRead-onlyRequired
post/areas/{areaId}/locker-rooms/{lockerRoomId}/accesses
POST /apis/v2/areas/{areaId}/locker-rooms/{lockerRoomId}/accesses HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "id": "text"
}
{
  "id": "text",
  "type": "OPEN",
  "startTime": "2026-01-01T00:00:00.000Z",
  "endTime": "2026-01-01T00:00:00.000Z"
}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
areaIdstringRequiredExample: les
Responses
200

Returns a LockerRoomCollection

application/json
_totalnumberRequired
_linksobjectRequired
get/areas/{areaId}/locker-rooms
GET /apis/v2/areas/{areaId}/locker-rooms HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Returns a LockerRoomCollection

{
  "items": [
    {
      "id": "text",
      "slug": "text",
      "displayName": "text",
      "displayNameShort": "text",
      "description": "text",
      "area": {},
      "_links": {}
    }
  ],
  "_total": 1,
  "_links": {}
}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
areaIdstringRequiredExample: w37
Responses
200Success
application/json
get/areas/{areaId}/replays/pricing
GET /apis/v2/areas/{areaId}/replays/pricing HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "quickReplay": {
    "enabled": true,
    "lengthSeconds": 1,
    "price": 1,
    "initialFree": 1
  },
  "customReplay": {
    "enabled": true,
    "minDurationSeconds": 1,
    "maxDurationSeconds": 1,
    "maxDaysToRequest": 1,
    "pricingIntervals": [
      {
        "minDurationSeconds": 1,
        "maxDurationSeconds": 1,
        "price": 1
      }
    ],
    "pricePerMinute": 1
  },
  "enhancedReplay": {
    "enabled": true,
    "pricePerMinute": 1
  }
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
areaIdstringRequiredExample: w37
Body
Responses
200

Returns the updated ReplayPricing config

application/json
post/areas/{areaId}/replays/pricing
POST /apis/v2/areas/{areaId}/replays/pricing HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 326

{
  "quickReplay": {
    "enabled": true,
    "lengthSeconds": 1,
    "price": 1,
    "initialFree": 1
  },
  "customReplay": {
    "enabled": true,
    "minDurationSeconds": 1,
    "maxDurationSeconds": 1,
    "maxDaysToRequest": 1,
    "pricingIntervals": [
      {
        "minDurationSeconds": 1,
        "maxDurationSeconds": 1,
        "price": 1
      }
    ],
    "pricePerMinute": 1
  },
  "enhancedReplay": {
    "enabled": true,
    "pricePerMinute": 1
  }
}
{
  "quickReplay": {
    "enabled": true,
    "lengthSeconds": 1,
    "price": 1,
    "initialFree": 1
  },
  "customReplay": {
    "enabled": true,
    "minDurationSeconds": 1,
    "maxDurationSeconds": 1,
    "maxDaysToRequest": 1,
    "pricingIntervals": [
      {
        "minDurationSeconds": 1,
        "maxDurationSeconds": 1,
        "price": 1
      }
    ],
    "pricePerMinute": 1
  },
  "enhancedReplay": {
    "enabled": true,
    "pricePerMinute": 1
  }
}

Last updated

Was this helpful?