Public API

Locations

4 endpoints.

GET/api/v1/public/locations

List locations

All active locations for the business, ordered by display_order. Paginated.

Parameters

Name	In	Type	Description
`page`	query	`integer`	default 1
`per_page`	query	`integer`	default 10
`X-API-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_PublicLocation__

Field Type Description

request_idrequired string

success true default true

datarequired

PublicLocation[]

PublicLocation[] fields

Field	Type	Description
`id`required	`string`
`name`	`string \| null`
`slug`	`string \| null`
`address_line_1`	`string \| null`
`address_line_2`	`string \| null`
`city`	`string \| null`
`state`	`string \| null`
`zip_code`	`string \| null`
`country`	`string \| null`
`is_primary`	`boolean`	default false
`active`	`boolean`	default true
`phone`	`string \| null`
`email`	`string \| null`
`description`	`string \| null`
`description_markdown`	`string \| null`
`timezone`	`string \| null`
`business_hours`	`PublicBusinessHours \| object \| null`	PublicBusinessHours \| object \| null fields Nested object (not expanded)
`photo_attachments`	`PublicPhotoAttachment[]`	PublicPhotoAttachment[] fields Nested object (not expanded)

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

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.

GET/api/v1/public/locations/{location_id}

Get location by ID

Get a single location by id. 404 if not found.

Parameters

Name	In	Type	Description
`location_id`required	path	`string (uuid)`
`X-API-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_PublicLocation_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`PublicLocation`	PublicLocation fields PublicLocation, 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/public/locations/by_slug/{slug}

Get location by slug

Get a single location by slug. 404 if not found.

Parameters

Name	In	Type	Description
`slug`required	path	`string`
`X-API-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_PublicLocation_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`PublicLocation`	PublicLocation fields PublicLocation, 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/public/locations/primary

Get primary location (real or placeholder)

Parameters

Name	In	Type	Description
`X-API-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field Type Description

request_idrequired string

success true default true

datarequired object

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

ResponseMeta, expanded above.

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

Error bodies: ErrorResponse. See Errors.