Console API

Locations

6 endpoints.

GET/api/v1/admin/businesses/{business_id}/locations

Get all locations

Get all locations for a business. By default only active; set listInactive=true to include inactive.

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`list_inactive`	query	`boolean`	default false
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_LocationData__

Field Type Description

request_idrequired string

success true default true

datarequired

LocationData[]

LocationData[] fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`location_name`required	`string`
`is_primary_location`	`boolean`	default false
`is_active_location`	`boolean`	default true
`address`	`Address \| null`	Address fields Address (not expanded)
`phone`	`string \| null`
`email`	`string \| null`
`description`	`string \| null`
`timezone`	`string \| null`
`business_hours`	`BusinessHours \| null`	BusinessHours fields BusinessHours (not expanded)
`slug`required	`string`
`photos`	`PhotoData[]`	PhotoData[] fields Nested object (not expanded)
`display_order`	`integer`	default 0

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/locations

Create location

Create a new location.

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonLocationCreateBody

Field Type Description

location_namerequired string

is_primary_location boolean default false

is_active_location boolean default true

address

Address | null

Address fields

Field	Type	Description
`line1`	`string \| null`
`line2`	`string \| null`
`city`	`string \| null`
`state`	`string \| null`
`zip_code`	`string \| null`
`country`	`string \| null`

phone string | null

email string | null

description string | null

timezone string | null

business_hours

BusinessHours | null

BusinessHours fields

Field Type Description

monday

DayHours | null

DayHours fields

Field	Type	Description
`is_open`	`boolean`	default true
`open_time`	`string \| null`
`close_time`	`string \| null`

tuesday

DayHours | null

DayHours fields

DayHours, expanded above.

wednesday

DayHours | null

DayHours fields

DayHours, expanded above.

thursday

DayHours | null

DayHours fields

DayHours, expanded above.

friday

DayHours | null

DayHours fields

DayHours, expanded above.

saturday

DayHours | null

DayHours fields

DayHours, expanded above.

sunday

DayHours | null

DayHours fields

DayHours, expanded above.

slug string | null

photo_ids

string[]

max items 5

string[] fields

Responses

201Successful Response

application/jsonSuccessResponse_LocationData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`LocationData`	LocationData fields LocationData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/locations/{location_id}

Get location details

Get location by id. 404 if not found.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`location_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_LocationData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`LocationData`	LocationData fields LocationData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

PUT/api/v1/admin/businesses/{business_id}/locations/{location_id}

Update location

Update location details. 404 if not found.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`location_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonLocationUpdateBody

Field	Type	Description
`location_name`	`string \| null`
`is_primary_location`	`boolean \| null`
`is_active_location`	`boolean \| null`
`address`	`Address \| null`	Address fields Address, expanded above.
`phone`	`string \| null`
`email`	`string \| null`
`description`	`string \| null`
`timezone`	`string \| null`
`business_hours`	`BusinessHours \| null`	BusinessHours fields BusinessHours, expanded above.
`slug`	`string \| null`
`photo_ids`	`string[] \| null`	string[] \| null fields

Responses

200Successful Response

application/jsonSuccessResponse_LocationData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`LocationData`	LocationData fields LocationData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

DELETE/api/v1/admin/businesses/{business_id}/locations/{location_id}

Delete location

Delete a location. 404 if not found.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`location_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

204Successful Response

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

PUT/api/v1/admin/businesses/{business_id}/locations/reorder

Reorder locations

Reorder locations by ordered list of location ids.

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonLocationReorderBody

Field	Type	Description
`ordered_location_ids`required	`string[]`	string[] fields

Responses

200Successful Response

application/jsonSuccessResponse_list_LocationData__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`LocationData[]`	LocationData[] fields LocationData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.