Zoca

Zoca Entities API

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

GitHub OpenAPI

Operations 78

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoca/refs/heads/main/openapi/zoca-entities-api-openapi.yml

Other Resources

🔗
Components
https://raw.githubusercontent.com/api-evangelist/zoca/refs/heads/main/components/zoca-components.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zoca-entities-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

zoca-entities-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Zoca Entities API
  contact: {}
  x-refined-note:
  - x-apievangelist-note differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Entities across 2 of this provider''s published API definitions: zoca-platform-openapi.yml, zoca-tasks-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.zoca.ai
  description: Production
- url: https://tasks.zoca.ai
  description: Production
tags:


# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoca/refs/heads/main/openapi/zoca-entities-api-openapi.yml