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 Widget API

The frontdesk-widget API from Zoca — 28 operation(s) for frontdesk-widget.

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

Tagged areas include frontdesk-widget. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 29 operations across 28 paths. It is described by OpenAPI 3.2.0, at version 3.20.9.

Requests are made against a single base URL, https://tasks.zoca.ai.

29 operations 28 paths 0 schemas 1 DELETE11 GET1 PATCH16 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Zoca Frontdesk Widget API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (access-token). By default, every request must be authenticated.

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

Paths & Operations 29

Across 28 paths, the API surfaces 29 operations — 1 DELETE, 11 GET, 1 PATCH, 16 POST. Each is listed below with its method, path, parameters, and response codes.

frontdesk-widget 29
GET
/tasks/api/v1/frontdesk/widget/{entityId}/agent/turn
Conversational booking-agent turn (SSE stream)
t_value → 200
GET
/tasks/api/v1/frontdesk/widget/{entityId}/home-suggestions
Quick-book suggestion cards for the widget home
t_value → 200
GET
/tasks/api/v1/frontdesk/widget/{entityId}/service-slots
On-demand slot options for one home-card service
t_value → 200
POST
/tasks/api/v1/frontdesk/widget/{entityId}/card/setup-intent
Create a Stripe SetupIntent to vault a card in the widget
t_value → 201
POST
/tasks/api/v1/frontdesk/widget/{entityId}/client/identity
Attach name + phone to a web client before a card-on-file booking
t_value → 201
GET
/tasks/api/v1/frontdesk/widget/{entityId}/card-on-file
Whether the widget's client already has a saved card
t_value → 200
POST
/tasks/api/v1/frontdesk/widget/{entityId}/quick-book
One-click deterministic booking for a quick-book slot
t_value → 201
POST
/tasks/api/v1/frontdesk/widget/{entityId}/learn
Ingest a business website into the agent knowledge base (internal)
t_value → 201
GET
/tasks/api/v1/frontdesk/widget/{entityId}/config
Booking-widget config: first page of services + categories + prefs
t_value → 200
GET
/tasks/api/v1/frontdesk/widget/{entityId}/services
Booking-widget: paginated/searchable services
t_value → 200
GET
/tasks/api/v1/frontdesk/widget/{entityId}/staff
Booking-widget staff/providers for an entity
t_value → 200
GET
/tasks/api/v1/frontdesk/widget/{entityId}/addons
Booking-widget add-ons (suggestable extras + staff surcharges)
t_value → 200
GET
/tasks/api/v1/frontdesk/widget/{entityId}/slots
Booking-widget available slots for a service + date
t_value → 200
GET
/tasks/api/v1/frontdesk/widget/{entityId}/availability
Booking-widget: dates with openings (grouped by date) for a service
t_value → 200
POST
/tasks/api/v1/frontdesk/widget/{entityId}/client
Booking-widget: find-or-create the platform client
t_value → 201
POST
/tasks/api/v1/frontdesk/widget/{entityId}/identify
Booking-widget: resolve the customer pricing tier
t_value → 201
POST
/tasks/api/v1/frontdesk/widget/{entityId}/price
Booking-widget: display-only price quote (never charges)
t_value → 201
POST
/tasks/api/v1/frontdesk/widget/{entityId}/verify-promo
Booking-widget: verify a promo code (no charge, no redemption)
t_value → 201
POST
/tasks/api/v1/frontdesk/widget/{entityId}/lead
Booking-widget: create a booking inquiry (engages lead follow-up)
t_value → 201
POST
/tasks/api/v1/frontdesk/widget/{entityId}/funnel
Booking-widget: report a funnel step (service/slot selected)
t_value → 201
POST
/tasks/api/v1/frontdesk/widget/{entityId}/card-status
Booking-widget: card-on-file requirement + on-file status
t_value → 201
POST
/tasks/api/v1/frontdesk/widget/{entityId}/collect-card
Booking-widget: mint a secure card-collection link
t_value → 201
POST
/tasks/api/v1/frontdesk/widget/{entityId}/book
Booking-widget: create an appointment
t_value → 201
POST
/tasks/api/v1/frontdesk/widget/{entityId}/hold
Booking-widget: hold a slot (reserve timer)
t_value → 201
POST
/tasks/api/v1/frontdesk/widget/{entityId}/cart/items
Booking-widget: add a service (its own slot + staff) to the cart
t_value → 201
PATCH
/tasks/api/v1/frontdesk/widget/{entityId}/cart/items/{itemId}
Booking-widget: re-slot / re-staff a cart item
t_value → 200
DELETE
/tasks/api/v1/frontdesk/widget/{entityId}/cart/items/{itemId}
Booking-widget: remove a cart item
t_value → 200
GET
/tasks/api/v1/frontdesk/widget/{entityId}/cart
Booking-widget: read the cached cart
t_value → 200
POST
/tasks/api/v1/frontdesk/widget/{entityId}/cart/checkout
Booking-widget: book the whole cart as one multi-service appointment
t_value → 201

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoca-frontdesk-widget-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 Widget 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.