List Locations

GET

/businesses/{businessId}/locations

• production

List all locations for a business.

Authorizations

• apiKey

Parameters

Path Parameters

businessId

required

string format: uuid

Business ID

Responses

200

A list of locations.

object

data

Array<object>

Location

A physical or virtual location where services can be provided

object

id

required

Unique identifier across the platform.

string format: uuid

name

required

The name of the location

string

Example

Downtown Office

description

A description of the location

string

nullable

Example

Our main office in the city center

instructions

Instructions for finding or accessing the location

string

nullable

Example

Enter through the main entrance and take the elevator to the 5th floor

address

The physical address of the location

string

nullable

Example

123 Main St, New York, NY 10001

lat

Latitude of the location

number format: float

nullable

lng

Longitude of the location

number format: float

nullable

timezone

The timezone of the location

string

Example

America/New_York

phone

Phone number of the location

string

nullable

email

Email address of the location

string format: email

nullable

pictureUrl

URL of the location’s picture

string format: uri

nullable

services

Services offered at the location

Array<object>

object

id

Unique identifier across the platform.

string format: uuid

name

Name of the service

string

createdAt

Timestamp of when the location was created

string format: date-time

updatedAt

Timestamp of when the location was last updated

string format: date-time

401

Location requires authentication

object

error

object

code

number

Example

404

title

string

Example

Not Found

404

Location not found

object

error

object

code

number

Example

404

title

string

Example

Not Found