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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Zoca

Zoca Entities API

The Entities API from Zoca — 66 operation(s) for entities.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 78 operations across 66 paths, and defines 2 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.

78 operations 66 paths 2 schemas 2 DELETE35 GET26 POST15 PUT

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 Entities 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 78

Across 66 paths, the API surfaces 78 operations — 2 DELETE, 35 GET, 26 POST, 15 PUT. Each is listed below with its method, path, parameters, and response codes.

Entities 78
POST
/entities/{entityId}/backfill-timezone
Backfill timezone for a single location from its address
t_value 1 param → 201
POST
/entities/backfill-timezone/batch
Backfill timezone for all null-timezone locations (paged)
t_value → 201
GET
/entities/links
Get booking links for an entity
t_value → 200
PUT
/entities/links
Update booking links for an entity
t_value → 200
GET
/entities/{entityId}/website-theme
Get the scraped website theme (colors + fonts) for an entity
t_value 1 param → 200
GET
/entities/currency
Get currency for given entity id
t_value 2 params → 200
GET
/entities/locations
Get all locations for a user
t_value → 200
POST
/entities/trigger-event
Trigger a custom event for an entity
t_value → 201
POST
/entities/onboarding-state
Update onboarding state for an entity
t_value → 201
GET
/entities/location/{entityId}
Get GBP location data by entity ID
t_value → 200
PUT
/entities/location/{entityId}
Update location data
t_value 1 param → 200400404
GET
/entities/location/{entityId}/details
Get essential location details
t_value 1 param → 200400404
GET
/entities/location/{entityId}/rwg-status
Get Reserve with Google status
t_value 1 param → 200
GET
/entities/location/{entityId}/users
Get users associated with a location
t_value → 200
POST
/entities/location/{entityId}/offboard
Offboard a location and optionally cancel subscriptions
t_value → 201
POST
/entities/location/{entityId}/resurrect
Resurrect a previously offboarded location
t_value → 201
PUT
/entities/location/{entityId}/test
Mark an entity as a test entity
t_value → 200
GET
/entities/{entityId}/is-test
Check if an entity is marked as a test entity
t_value → 200400
GET
/entities/{entityId}/more-tab-cards
Get visibility markers for More tab cards
t_value 1 param → 200400
GET
/entities/products/{entityId}
Get products for an entity
t_value 1 param → 200
PUT
/entities/products/{entityId}
Create or update a product entity relationship
t_value → 200400
GET
/entities/{entityId}/scheduling-active
Check whether the scheduling product is active for an entity
t_value → 200
GET
/entities/products/{entityId}/features
Get features available for entity products
t_value → 200
PUT
/entities/products/{entityId}/{productId}/deactivate
Mark a product entity relationship as inactive
t_value → 200400404
PUT
/entities/location/{entityId}/lead-masking
Update lead masking settings for a location
t_value → 200
POST
/entities/{entityId}/preferences
Create or update an entity preference
t_value → 201
GET
/entities/{entityId}/preferences
Get preferences for an entity
t_value → 200
DELETE
/entities/{entityId}/preferences
Soft-delete entity preferences
t_value 1 param → 204400
POST
/entities/{entityId}/preferences/bulk
Bulk upsert multiple preferences for a single entity
t_value → 200
POST
/entities/account
Create a new entity account with user, location, and business
t_value → 201
POST
/entities/location/manual
Create a business + location without GBP (standalone bookings)
t_value → 201
GET
/entities/{entityId}/preferences/paginated
List entity preferences with pagination, search, and attribute-prefix filtering
t_value → 200
POST
/entities/{entityId}/preferences/bulk/fetch
Get preferences for an entity filtered to a list of attributes
t_value → 200
GET
/entities/{entityId}/effective-preferences
Get effective preferences with hierarchy resolution
t_value → 200
GET
/entities/users/{entityId}/locations
Get locations associated with a user
t_value → 200
POST
/entities/{entityId}/virtual-number
Create a virtual phone number for an entity
t_value → 201
POST
/entities/{entityId}/additional-phone
Add additional phone number for a user/SP
t_value → 201400
GET
/entities/{entityId}/phones
Get phone numbers for an entity with optional filters
t_value → 200
GET
/entities/location/{entityId}/booking-link
Get booking link for a location
t_value → 200
PUT
/entities/location/{entityId}/booking-link
Update booking link for a location
t_value → 200
PUT
/entities/phones
Upsert a phone record
t_value → 200
GET
/entities/offboarding-reason-templates
Get active offboarding reason templates
t_value 2 params → 200400
POST
/entities/offboarding-reason-templates
Add a new offboarding reason template
t_value → 201400
PUT
/entities/offboarding-reason-templates/{id}
Update an existing offboarding reason template
t_value → 200400404
POST
/entities/offboarding-reason-template-mappings
Create a mapping between an entity and a reason template
t_value → 201404
PUT
/entities/offboarding-reason-template-mappings/{entityId}/{reasonId}
Update a reason template mapping
t_value → 200404
GET
/entities/offboarding/active-subscriptions/{entityId}
Get active subscriptions and offboarding information for an entity
t_value → 200400401403404500
GET
/entities/offboarding/active-subscriptions/v2/{entityId}
Get active subscriptions and offboarding information for an entity (with HubSpot meeting)
t_value → 200400401500
POST
/entities/defaults
Create or update a global default preference
t_value → 201400
GET
/entities/defaults
Get global default preferences
t_value → 200
PUT
/entities/defaults/{id}
Update a global default preference
t_value → 200400404
DELETE
/entities/defaults/{id}
Delete a global default preference
t_value → 204400404
PUT
/entities/links/credentials/{linkId}
Create or update credentials for a link
t_value 1 param → 200400404500
POST
/entities/links/{linkId}/scrape
Start scraping task for booking platform data
t_value 1 param → 200400404500
POST
/entities/optexity/callback
Receive callback from Optexity when scraping task completes
t_value → 200400
POST
/entities/location/{entityId}/social-media-churn
Mark location as churned for social media
t_value → 200400500
POST
/entities/agent-activation-logs
Create agent activation log entry
t_value → 201400
POST
/entities/{entityId}/trigger-payment-link-comms
Trigger payment link communications for an entity
t_value 1 param → 200400404500
GET
/entities/{entityId}/meetings
Get latest meetings for an entity
t_value 2 params → 200400404500
POST
/entities/{entityId}/review-insights
Get review insights for an entity
t_value 1 param → 200400500
GET
/entities/website/{entityId}/faqs
Get FAQs for an entity
t_value 1 param → 200
POST
/entities/website/faqs/bulk-upsert
Bulk upsert FAQs for entities
t_value → 201400500
GET
/entities/{entityId}/status
Get entity status information
t_value 1 param → 200404
PUT
/entities/{entityId}/users/{userId}/service-provider
Toggle service provider status for user
t_value 2 params body → 200400404
GET
/entities/{entityId}/service-providers
Get service providers for a location
t_value 1 param → 200404
GET
/entities/{entityId}/hubspot/meetings
Get upcoming HubSpot meetings for an entity
t_value 2 params → 200400
GET
/entities/{entityId}/call-now-settings
Get Call Now button settings
t_value 1 param → 200404
PUT
/entities/{entityId}/call-now-settings
Update Call Now button settings
t_value 1 param body → 200400
GET
/entities/{entityId}/cta-config
Get CTA configuration
t_value 1 param → 200
PUT
/entities/{entityId}/cta-config
Update CTA configuration
t_value 1 param body → 200400
POST
/tasks/api/v1/entities/leads/demo/report
Trigger demo lead report notification
t_value → 201
POST
/tasks/api/v1/entities/keywords
Create or update keyword entities for a given entity
t_value → 200400
GET
/tasks/api/v1/entities/keywords
Get keywords for an entity by type
t_value 2 params → 200
GET
/tasks/api/v1/entities/businesses
List or search businesses by title (internal drill-down typeahead)
t_value 3 params → 200
GET
/tasks/api/v1/entities/businesses/{businessId}/locations
List locations attached to a business (BUSINESSLOCATION)
t_value 1 param → 200
GET
/tasks/api/v1/entities/locations/{locationId}/users-with-phones
List users at a location with their phone numbers bundled inline (VIRTUALNUMBER, WORK, PERSONAL)
t_value 1 param → 200
GET
/tasks/api/v1/entities/phone/{entityId}
Get phone numbers for an entity (optionally filter by type)
t_value 2 params → 200500
POST
/tasks/api/v1/entities/locations/backfill-coordinates
Backfill location coordinates
t_value body → 201500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are e (6 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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoca-entities-api-openapi.yml Raw ↑

Other APIs Zoca publishes across the network.

Zoca ACM API
AE Profile APIs.io
Zoca Acuity API
AE Profile APIs.io
Zoca Addon Groups API
AE Profile APIs.io
Zoca Addons API
AE Profile APIs.io
Zoca Aeo Lead Magnet API
AE Profile APIs.io
Zoca Agents API
AE Profile APIs.io
Zoca API Keys API
AE Profile APIs.io
Zoca App API
AE Profile APIs.io
Zoca App Blocker API
AE Profile APIs.io
Zoca App Blocker Updates API
AE Profile APIs.io
Zoca Approvals API
AE Profile APIs.io
Zoca Auth API
AE Profile APIs.io
#Entities
← Back to Z APIs
API Details
ID
zoca:zoca-entities-api
Base URL
https://api.zoca.ai
Docs
https://app.zoca.com/
Provider
Zoca
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=zoca-entities-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zoca-entities-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Zoca Entities 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.