Areas
Specific locations within a region, such as buildings or outdoor sections.
If not set, defaults to now
2021-09-08T00:00:00ZIf not set, the response will include up to 1 day ahead since startTime
["items._links.availableCoaches"]["d94320d9-a8f7-4d3d-92ae-3ef7a6285a5a"]["les","w37"]Returns a AreaCollection
GET /apis/v2/areas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
}
}
}Custom text to display when status is COMING_SOON (max 40 chars)
Returns an Area
Custom text to display when status is COMING_SOON (max 40 chars)
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": {}
}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": {}
}Returns a Area
Custom text to display when status is COMING_SOON (max 40 chars)
No Areas found within 200mi
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": {}
}w37["_links.availableCoaches","_links.replaysPricing"]Returns an Area
Custom text to display when status is COMING_SOON (max 40 chars)
GET /apis/v2/areas/{areaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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": {}
}w37["_links.availableCoaches"]Returns an Area
Custom text to display when status is COMING_SOON (max 40 chars)
DELETE /apis/v2/areas/{areaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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": {}
}w37Custom text to display when status is COMING_SOON (max 40 chars)
Returns an Area
Custom text to display when status is COMING_SOON (max 40 chars)
Returns an ErrorDto in case of validation errors or failures.
Possible error codes are:A0002: Priority must be greater or equal to zero.A0003: Street must be set.A0004: City must be set.A0005: Borough must be set.A0006: Latitude must be set.A0007: Longitude must be set.A0008: Display Name must be set.A0009: Slug must be set.A0010: Region must be set.A0011: Display Name Short must be set.A0012: Invalid slug format. Use lowercase and hyphens, e.g., "this-is-an-example".A0013: Invalid Stripe Account ID. Must start with "acct_".A0014: Invalid tax settings: {{validationErrors}}A0015: An area liability waiver is required to make this location available. Please ensure the waiver is in place. To save your changes, set the location status to NOT AVAILABLEA0016: A kids area liability waiver is required to make this location available. Please ensure the waiver is in place. To save your changes, set the location status to NOT AVAILABLE
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": {}
}w37["feature","admin","branding"]Returns AreaSettings
GET /apis/v2/areas/{areaId}/settings HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Returns AreaSettings
{
"items": [
{
"id": "area.timezone",
"value": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}This endpoint is deprecated and will be removed in the future. Please use /areas/:areaId/settings?scope=branding instead.
w37Returns AreaBrandingSettingsCollection
GET /apis/v2/areas/{areaId}/branding HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Returns AreaBrandingSettingsCollection
{
"items": [
{
"id": "area.membershipHeaderHtml",
"value": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}w37["items._links.tables"]Returns a PodCollection
GET /apis/v2/areas/{areaId}/pods HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
}
}
}w37If not set, defaults to now
2021-09-08T00:00:00ZIf not set, the response will include up to 1 day ahead since startTime
["HUMAN","ROBOT"]Returns the Area available CoachProfilees
GET /apis/v2/areas/{areaId}/available-coaches HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
}
}
}les-locker-roomlesReturns an AccessDto
Returns an error
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"
}lesReturns a LockerRoomCollection
GET /apis/v2/areas/{areaId}/locker-rooms HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Returns a LockerRoomCollection
{
"items": [
{
"id": "text",
"slug": "text",
"displayName": "text",
"displayNameShort": "text",
"description": "text",
"area": {},
"_links": {}
}
],
"_total": 1,
"_links": {}
}w37Area not found
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
}
}w37Returns the updated ReplayPricing config
Area not found
Unable to update replay pricing. Please try again or contact support if the problem persists.
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?

