Location data model

formatted address string + lat/long) and PlayHQ venues (structured address parts).

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNoUnique identifier for this location
created_atstring (date-time)NoThe date that this location was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this location was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
group_idstringNoThe group this location is associated with (reference to HrisGroup)
namestringNoThe location name
addressobjectNo
address.address1stringNo
address.address2stringNo
address.citystringNo
address.regionstringNo
address.region_codestringNo
address.postal_codestringNo
address.countrystringNo
address.country_codestringNoISO 2-digit country code
latitudenumberNoThe latitude
longitudenumberNoThe longitude
telephonestringNoA contact phone number for the location
urlstringNoA URL for the location

TypeScript

TypeScript
export type ClubsLocation = {
	id?: string; // Unique identifier for this location
	created_at?: string-time; // The date that this location was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this location was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	group_id?: string; // The group this location is associated with (reference to HrisGroup)
	name?: string; // The location name
	address?: {
		address1?: string; 
		address2?: string; 
		city?: string; 
		region?: string; 
		region_code?: string; 
		postal_code?: string; 
		country?: string; 
		country_code?: string; // ISO 2-digit country code 
	};
	latitude?: number; // The latitude
	longitude?: number; // The longitude
	telephone?: string; // A contact phone number for the location
	url?: string; // A URL for the location
	raw?: any; // The raw data returned by the integration for this location
} 

Zod

Zod
import { z } from 'zod';

export const ZodClubsLocation = z.object({
	id: z.string().optional().describe("Unique identifier for this location"),
	created_at: z.string-time().optional().describe("The date that this location was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this location was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	group_id: z.string().optional().describe("The group this location is associated with (reference to HrisGroup)"),
	name: z.string().optional().describe("The location name"),
	address: z.object({
			address1: z.string().optional(),
			address2: z.string().optional(),
			city: z.string().optional(),
			region: z.string().optional(),
			region_code: z.string().optional(),
			postal_code: z.string().optional(),
			country: z.string().optional(),
			country_code: z.string().optional().describe("ISO 2-digit country code")
}).optional(),
	latitude: z.number().optional().describe("The latitude"),
	longitude: z.number().optional().describe("The longitude"),
	telephone: z.string().optional().describe("A contact phone number for the location"),
	url: z.string().optional().describe("A URL for the location"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PropertyClubsLocationAddress:
	address1: Optional[str]
	address2: Optional[str]
	city: Optional[str]
	region: Optional[str]
	region_code: Optional[str]
	postal_code: Optional[str]
	country: Optional[str]
	"""ISO 2-digit country code"""
	country_code: Optional[str]

@dataclasses.dataclass
class ClubsLocation:
	"""Unique identifier for this location"""
	id: Optional[str]
	"""The date that this location was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this location was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The group this location is associated with (reference to HrisGroup)"""
	group_id: Optional[str]
	"""The location name"""
	name: Optional[str]
	address: Optional[PropertyClubsLocationAddress]
	"""The latitude"""
	latitude: Optional[int]
	"""The longitude"""
	longitude: Optional[int]
	"""A contact phone number for the location"""
	telephone: Optional[str]
	"""A URL for the location"""
	url: Optional[str]
Are we missing anything? Let us know
Was this page helpful?