How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoca Frontdesk API

The Frontdesk API from Zoca — 27 operation(s) for frontdesk.

Zoca Frontdesk API is one of 193 APIs that Zoca publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Front Desk. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 28 operations across 27 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.zoca.ai, https://tasks.zoca.ai.

28 operations 27 paths 4 schemas 1 DELETE14 GET13 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.zoca.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Zoca Frontdesk API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (access-token).

  • access-token — Enter JWT token in the format Bearer

Paths & Operations 28

Across 27 paths, the API surfaces 28 operations — 1 DELETE, 14 GET, 13 POST. Each is listed below with its method, path, parameters, and response codes.

Frontdesk 28
GET
/frontdesk/multilocation/{businessEntityId}/overview
Front Desk Control Tower — network overview
t_value 1 param → 200
GET
/frontdesk/multilocation/{businessEntityId}/locations
Front Desk Control Tower — ranked locations table
t_value 1 param → 200
GET
/frontdesk/multilocation/{businessEntityId}/activity
Front Desk Control Tower — network activity feed
t_value 1 param → 200
POST
/frontdesk/handover/{clientId}/toggle
Toggle human handover for a client
t_value 1 param → 201
POST
/frontdesk/handover/{clientId}/deactivate
Deactivate human handover for a client
t_value 1 param → 201
GET
/frontdesk/handover/{clientId}/status
Check whether a client is in human handover (soft or hard)
t_value 2 params → 200
GET
/frontdesk/status/{entityId}
Get Frontdesk onboarding status
t_value 1 param → 200404
GET
/frontdesk/overview/{locationEntityId}
Front Desk dashboard — Overview cards (v1)
t_value 1 param → 200
GET
/frontdesk/analytics/{locationEntityId}
Front Desk dashboard — Analytics tab (7 widgets)
t_value 1 param → 200
GET
/frontdesk/analytics-v2/{locationEntityId}
Front Desk dashboard — Analytics tab v2 (real data from callcallbacks)
t_value 1 param → 200
GET
/frontdesk/bookings/{entityId}
List frontdesk bookings for an entity
t_value 1 param → 200
POST
/tasks/api/v1/frontdesk/chat
Chat with the Frontdesk Agent
t_value body → 200
POST
/tasks/api/v1/frontdesk/chat/stream
Chat with streaming via SSE
t_value body → 201
POST
/tasks/api/v1/frontdesk/message
Single message (no conversation history)
t_value body → 200
POST
/tasks/api/v1/frontdesk/manual-message
Send a manual (human-authored) message to a customer
t_value body → 201
GET
/tasks/api/v1/frontdesk/conversations/{conversationId}
Get conversation info
t_value 2 params → 200
DELETE
/tasks/api/v1/frontdesk/conversations/{conversationId}
End a conversation
t_value 2 params → 200
GET
/tasks/api/v1/frontdesk/conversations
List conversations for an entity
t_value 2 params → 200
GET
/tasks/api/v1/frontdesk/conversations/{conversationId}/messages
Get conversation messages
t_value 3 params → 200
GET
/tasks/api/v1/frontdesk/conversations/by-client/{clientId}/messages
Get a client's frontdesk conversation messages (resolves conversationId)
t_value 3 params → 200
POST
/tasks/api/v1/frontdesk/webhooks/card-complete
Card-on-file completion callback (PCI → mononest, all platforms)
t_value[0] → 200
POST
/tasks/api/v1/frontdesk/webhooks/boulevard/card-complete
Card-on-file completion callback (PCI → mononest, all platforms)
t_value[1] → 200
POST
/tasks/api/v1/frontdesk/webhooks/mindbody/card-complete
Card-on-file completion callback (PCI → mononest, all platforms)
t_value[2] → 200
GET
/tasks/api/v1/frontdesk/card-links/{bookingRef}/slot
Card-link slot availability re-check (hosted card page)
t_value 1 param → 200
POST
/tasks/api/v1/frontdesk/webhooks/sms
Inbound SMS → Frontdesk agent (generic)
t_value body → 200404
POST
/tasks/api/v1/frontdesk/webhooks/twilio/sms
Twilio inbound-SMS webhook (JSON mode) → Frontdesk agent
t_value body → 200
POST
/tasks/api/v1/frontdesk/webhooks/retell/incoming-call
Retell callinbound webhook → dynamicvariables envelope
t_value body → 200
POST
/tasks/api/v1/frontdesk/webhooks/retell/call-events
Retell unified call-events webhook
t_value body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are e (6 properties), e_3 (5 properties), e_2 (5 properties). Each schema is shown below with its type and property counts.

e
object
6 properties 3 required
e_2
object
5 properties 5 required
Object
object
e_3
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoca-frontdesk-api-openapi.yml Raw ↑

Other APIs Zoca publishes across the network.

Zoca ACM API
Zoca Acuity API
Zoca Addon Groups API
Zoca Addons API
Zoca Aeo Lead Magnet API
Zoca Agents API
Zoca API Keys API
Zoca App API
Zoca App Blocker API
Zoca App Blocker Updates API
Zoca Approvals API
Zoca Auth API
Where this information came from

This is an independent, third-party profile of Zoca Frontdesk API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.