Retrieve the list of location groups in an organization

get https://api.zenoti.com/v1/organizations/{OrganizationId}/location_groups

The purpose of this API is to retrieve the list of all location groups in an organization on the listing page.

Response object

GetLocationGroupsResponse

Json Property	Data Type	Description
location_groups	List	List of location groups
num_records	int	Number of records
error	APIV2ErrorModel	Error while retrieving the data

LocationGroup

Json Property	Data Type	Description
id	string	Location group ID
name	string	Location group name
zone_id	string	Zone ID
code	string	Location group code
description	string	Location group description
centers	List	List of centers in the location group

LocationGroups

Json Property	Data Type	Description
location_group_id	String	Unique identifier for the location group
location_group_name	String	Name of the location group
zone_id	String	Identifier for the associated zone
location_group_code	String	Code for the location group
location_group_desc	String	Description of the location group
centers	Array	List of centers within the location group
center_ids	Array/Null	List of center IDs or null if not present

Center

Json Property	Data Type	Description
center_id	String	Unique identifier for the center
center_name	String	Name of the center

Root Object

Json Property	Data Type	Description
location_groups	Array	List of location groups
error	Null	Error information, null if no error

Language

Credentials

Header

Click Try It! to start a request and see the response here!