Console API

Front desk

3 endpoints.

GET/api/v1/admin/businesses/{business_id}/front-desk

Front Desk status for a business

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_FrontDeskStatusData_

Field Type Description

request_idrequired string

success true default true

datarequired

FrontDeskStatusData

FrontDeskStatusData fields

Field	Type	Description
`business_id`required	`string`
`enabled`required	`boolean`
`phone_number`	`string \| null`
`number_status`	`string \| null`
`primary_phone`	`string \| null`
`can_enable`required	`boolean`
`blocked_reason`	`enum \| null`

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}/front-desk/disable

Turn Front Desk off (releases the phone number right away)

Releases the number at Retell and marks it released here — the number is gone for good; turning Front Desk on again buys a fresh one. Idempotent when already off.

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_FrontDeskStatusData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`FrontDeskStatusData`	FrontDeskStatusData fields FrontDeskStatusData, 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.

POST/api/v1/admin/businesses/{business_id}/front-desk/enable

Turn Front Desk on (auto-provisions a phone number)

Buys a US number in the area code of the business's primary phone (same-state, then any-US fallback), binds the shared Front Desk agent, and activates it immediately. Idempotent when already on. 422 when the business has no primary phone; 503 when Retell is not configured.

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_FrontDeskStatusData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`FrontDeskStatusData`	FrontDeskStatusData fields FrontDeskStatusData, 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.