Generated by API Evangelist
Written by API Evangelist tooling for ZoomInfo's API. It is a proposal applied on top of the contract, not a document ZoomInfo publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Platform API V1 Entities API
version: 1.0.0
extends: openapi/zoominfo-entities-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/platform/v1/metadata/entities'].get
update:
x-apievangelist-phrasing:
intent: List GTM data model entities
effect: read
questions:
- Which entities exist in my GTM data model?
- Can I see all the object types available to my organization?
instructions:
- text: List the GTM entities available to us.
- text: Show every entity in our GTM data model.
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/v1/metadata/entities/{entityName}/fields'].get
update:
x-apievangelist-phrasing:
intent: Get field definitions for a GTM entity
effect: read
questions:
- What fields does a GTM entity have and how are they defined?
- Can I see the metadata for one entity's fields?
instructions:
- text: List the fields of entity {entityName}.
slots:
entityName: path.entityName
- text: Show field definitions for the {entityName} entity.
slots:
entityName: path.entityName
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/v1/entities/{entityName}'].post
update:
x-apievangelist-phrasing:
intent: Create or update GTM entity records
effect: write
questions:
- How do I write records into my GTM data model?
- Can I update existing entity records in bulk?
instructions:
- text: Upsert records {records} into entity {entityName}.
slots:
records: requestBody.data
entityName: path.entityName
- text: Save these {entityName} records {records}.
slots:
entityName: path.entityName
records: requestBody.data
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.