Copilot API is one of 8 APIs that ZoomInfo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 6 JSON Schema definitions.
The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.
This API exposes 33 operations across 23 paths, organized into 8 resource areas, and defines 142 schemas. It is described by OpenAPI 3.0.0, at version 1.0.
Requests are made against a single base URL, https://api.zoominfo.com/gtm.
33 operations
23 paths
142 schemas
5 DELETE13 GET15 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Copilot API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2Auth) using the authorizationCode flow, exposing 5 scopes.
By default, every request must be authenticated.
Paths & Operations 33
Across 23 paths, the API surfaces 33 operations — 5 DELETE, 13 GET, 15 POST. They span 8 resource areas: Insights, Recommendations, Account Summary, Customer Buyer Persona, Customer Competitors, Customer Settings, Ideal Customer Profile, Products and Services. Each is listed below with its method, path, parameters, and response codes.
Insights 1
POST
/copilot/v1/companies/insights
Get insights by type
Recommendations 3
GET
/copilot/v1/companies/lookalikes
Find Similar Companies
GET
/copilot/v1/contacts/lookalikes
Get Contact Lookalikes
GET
/copilot/v1/contacts/recommendations
Get Contact Recommendations
Account Summary 2
GET
/copilot/v1/companies/{companyId}/account-summary
Get Account Summary
POST
/copilot/v1/companies/{companyId}/account-summary/actions/ask
Ask Account Summary Question
Customer Buyer Persona 6
GET
/copilot/v1/customer-buyer-personas
List Customer Buyer Personas
POST
/copilot/v1/customer-buyer-personas
Upsert Customer Buyer Persona
GET
/copilot/v1/customer-buyer-personas/{buyerPersonaId}
Get Customer Buyer Persona
DELETE
/copilot/v1/customer-buyer-personas/{buyerPersonaId}
Delete Customer Buyer Persona
POST
/copilot/v1/customer-buyer-personas/{buyerPersonaId}/actions/archive
Archive Buyer Persona
POST
/copilot/v1/customer-buyer-personas/{buyerPersonaId}/actions/unarchive
Unarchive Buyer Persona
Customer Competitors 6
GET
/copilot/v1/customer-competitors
List Customer Competitors
POST
/copilot/v1/customer-competitors
Upsert Customer Competitor
GET
/copilot/v1/customer-competitors/{competitorId}
Get Customer Competitor by ID
DELETE
/copilot/v1/customer-competitors/{competitorId}
Delete Customer Competitor
POST
/copilot/v1/customer-competitors/{competitorId}/actions/archive
Archive Customer Competitor
POST
/copilot/v1/customer-competitors/{competitorId}/actions/unarchive
Unarchive Customer Competitor
Customer Settings 3
GET
/copilot/v1/customer-settings
Get Customer Settings
POST
/copilot/v1/customer-settings
Upsert Customer Settings
DELETE
/copilot/v1/customer-settings
Delete Customer Settings
Ideal Customer Profile 6
GET
/copilot/v1/ideal-company-profile
List Ideal Customer Profiles
POST
/copilot/v1/ideal-company-profile
Upsert Ideal Customer Profile
GET
/copilot/v1/ideal-company-profile/{segmentId}
Get an Ideal Customer Profile
DELETE
/copilot/v1/ideal-company-profile/{segmentId}
Delete Ideal Customer Profile
POST
/copilot/v1/ideal-company-profile/{segmentId}/actions/archive
Archive ICP
POST
/copilot/v1/ideal-company-profile/{segmentId}/actions/unarchive
Unarchive ICP
Products and Services 6
GET
/copilot/v1/products
List Products or Services
POST
/copilot/v1/products
Upsert Product or Service
GET
/copilot/v1/products/{offeringId}
Get Product or Service
DELETE
/copilot/v1/products/{offeringId}
Delete Product or Service
POST
/copilot/v1/products/{offeringId}/actions/archive
Archive Product or Service
POST
/copilot/v1/products/{offeringId}/actions/unarchive
Unarchive Product or Service
Schemas 142
The contract defines 142 schemas that model the data the API accepts and returns. The most detailed are MpocChangeSignalPayload (13 properties), CxoChangeSignalPayload (13 properties), BuyingCommitteeChangeSignalPayload (13 properties), PersonChangeSignalPayload (13 properties). Each schema is shown below with its type and property counts.
AccountSummaryAttributes
object
Attributes for the AccountSummary resource.
1 property
1 required
AccountSummary
object
Represents a summary of account-related data.
3 properties
3 required
AccountSummaryResponse
object
Resource model for an account summary response.
1 property
1 required
ZoomInfo.Core.Foundations.ErrorSourceModel
object
4 properties
ZoomInfo.Core.Foundations.ErrorModel
object
The object describing a specific error from the API
6 properties
3 required
ZoomInfo.Core.Foundations.ErrorResponseModel
object
The standard error response body model for the ZoomInfo API.
3 properties
1 required
AccountSummaryQuestionAttributes
object
Attributes for the AccountSummaryQuestion resource.
1 property
1 required
AccountSummaryQuestion
object
Represents a question and answer about account-related data.
3 properties
3 required
AccountSummaryQuestionResponse
object
Response model for asking a question about account-related data.
1 property
1 required
AccountSummaryQuestionRequestAttributes
object
Attributes for the AccountSummaryQuestionRequest resource.
1 property
1 required
AccountSummaryQuestionRequestResource
object
Represents a request to ask a question about account-related data.
2 properties
2 required
AccountSummaryQuestionRequest
object
Request model for asking a question about account-related data.
1 property
1 required
FundingSignalPayload
object
Funding signal payload - represents company funding events.
5 properties
5 required
FundingInsight
object
Funding insight model
8 properties
4 required
CxoChangeSignalPayload
object
CXO change signal payload.
13 properties
6 required
CxoChangeInsight
object
CXO change insight model
8 properties
4 required
ScoopsSignalPayload
object
Scoops signal payload.
3 properties
3 required
ScoopsInsight
object
Scoops insight model
8 properties
4 required
WebsightsSignalPayload
object
Websights signal payload - represents web activity insights.
5 properties
5 required
WebsightsInsight
object
Websights insight model
8 properties
4 required
BuyingCommitteeChangeSignalPayload
object
Buying committee change signal payload.
13 properties
6 required
BuyingCommitteeChangeInsight
object
Buying committee change insight model
8 properties
4 required
AliLocation
object
Account Level Intent (ALI) location information.
2 properties
2 required
AccountLevelIntentSignalPayload
object
Account level intent signal payload.
7 properties
5 required
AccountLevelIntentInsight
object
Account level intent insight model
8 properties
4 required
CompetitorIntentSignal
object
Competitor Intent Signal information.
5 properties
4 required
CompetitorIntentSignalPayload
object
Competitor intent signal payload.
3 properties
3 required
CompetitorIntentInsight
object
Competitor intent insight model
8 properties
4 required
MpocChangeSignalPayload
object
MPOC change signal payload.
13 properties
6 required
MpocChangeInsight
object
MPOC change insight model
8 properties
4 required
G2SignalPayload
object
G2 signal payload.
4 properties
4 required
G2Insight
object
G2 insight model
8 properties
4 required
TrustRadiusActivityLabel
string
Label indicating which type of TrustRadius page the activity occurred on.
TrustRadiusActivitySource
string
Source indicating where the TrustRadius activity originated.
TrustRadiusActivityType
string
Type of activity performed by a contact on TrustRadius.
ActivityLocationInfo
object
Activity location information for TrustRadius signals.
5 properties
TrustRadiusSignalPayload
object
TrustRadius signal payload.
13 properties
7 required
TrustRadiusInsight
object
TrustRadius insight model
8 properties
4 required
AnomalousHiringSignalPayload
object
Anomalous hiring signal payload.
4 properties
3 required
AnomalousHiringInsight
object
Anomalous hiring insight model
8 properties
4 required
FormStatus
string
Submission status of a completed form.
FormCompleteSignalPayload
object
Form complete signal payload.
11 properties
7 required
FormCompleteInsight
object
Form complete insight model
8 properties
4 required
PodcastMentionsSignalPayload
object
Podcast mentions signal payload.
6 properties
5 required
PodcastMentionsInsight
object
Podcast mentions insight model
8 properties
4 required
MarketingCampaignsSignalPayload
object
Marketing campaigns signal payload.
8 properties
8 required
MarketingCampaignsInsight
object
Marketing campaigns insight model
8 properties
4 required
TechnologyStatus
string
Indicates whether a technology was added to the company's tech stack.
TechnologySignalPayload
object
Technology signal payload.
7 properties
7 required
TechnologyInsight
object
Technology insight model
8 properties
4 required
SeniorJobPostingsSignalPayload
object
Senior job postings signal payload.
4 properties
3 required
SeniorJobPostingsInsight
object
Senior job postings insight model
8 properties
4 required
PersonWebsightsIntentLevel
string
Buying intent level inferred from a known contact's website visit behavior.
PersonWebsightsSignalPayload
object
Person websights signal payload.
11 properties
7 required
PersonWebsightsInsight
object
Person websights insight model
8 properties
4 required
PersonBasedNewsSignalPayload
object
Person based news signal payload.
11 properties
7 required
PersonBasedNewsInsight
object
Person based news insight model
8 properties
4 required
WonDealSignalPayload
object
Won deal signal payload.
9 properties
9 required
WonDealInsight
object
Won deal insight model
8 properties
4 required
NewContactPreviouslyWorkedForCustomerSignalPayload
object
New contact previously worked for customer signal payload.
13 properties
6 required
NewContactPreviouslyWorkedForCustomerInsight
object
New contact previously worked for customer insight model
8 properties
4 required
PersonChangeSignalPayload
object
Base model for person-related signal payloads with change tracking.
13 properties
6 required
PersonChangeInsight
object
Person change insight model
8 properties
4 required
UpcomingMeetingSignalPayload
object
Upcoming meeting signal payload.
6 properties
6 required
UpcomingMeetingInsight
object
Upcoming meeting insight model
8 properties
4 required
LowActiveContactsSignalPayload
object
Low active contacts signal payload.
4 properties
4 required
LowActiveContactsInsight
object
Low active contacts insight model
8 properties
4 required
NoDecisionMakerSignalPayload
object
No decision maker signal payload.
4 properties
4 required
NoDecisionMakerInsight
object
No decision maker insight model
8 properties
4 required
NoPostMeetingFollowUpSignalPayload
object
No post meeting follow up signal payload.
12 properties
7 required
NoPostMeetingFollowUpInsight
object
No post meeting follow up insight model
8 properties
4 required
UpcomingRenewalSignalPayload
object
Upcoming renewal signal payload.
4 properties
4 required
UpcomingRenewalInsight
object
Upcoming renewal insight model
8 properties
4 required
MASignalPayload
object
M&A signal payload.
3 properties
3 required
MAInsight
object
M&A insight model
8 properties
4 required
ProductLaunchSignalPayload
object
Product launch signal payload.
3 properties
3 required
ProductLaunchInsight
object
Product launch insight model
8 properties
4 required
EarningsSignalPayload
object
Earnings signal payload.
3 properties
3 required
EarningsInsight
object
Earnings insight model
8 properties
4 required
PartnershipSignalPayload
object
Partnership signal payload.
3 properties
3 required
PartnershipInsight
object
Partnership insight model
8 properties
4 required
LayoffsSignalPayload
object
Layoffs signal payload.
3 properties
3 required
LayoffsInsight
object
Layoffs insight model
8 properties
4 required
PainPointSignalPayload
object
Pain point signal payload.
3 properties
3 required
PainPointInsight
object
Pain point insight model
8 properties
4 required
DivestitureSignalPayload
object
Divestiture signal payload.
3 properties
3 required
DivestitureInsight
object
Divestiture insight model
8 properties
4 required
IPOSignalPayload
object
IPO signal payload.
3 properties
3 required
IPOInsight
object
IPO insight model
8 properties
4 required
AwardSignalPayload
object
Award signal payload.
3 properties
3 required
AwardInsight
object
Award insight model
8 properties
4 required
ProjectSignalPayload
object
Project signal payload.
3 properties
3 required
ProjectInsight
object
Project insight model
8 properties
4 required
InsightUnion
object
CompanyInsight
object
Attributes for company insight.
1 property
1 required
CompanyInsightsByTypeResponseResource
object
Company insights by type response resource.
3 properties
3 required
CompanyInsightsByTypeResponse
object
Response model for retrieving company insights by type.
1 property
1 required
SignalType
string
Type of sales intelligence signal for a company insight.
CompanyInsightsByTypeRequestAttributes
object
Request attributes for retrieving company insights filtered by signal type.
2 properties
1 required
CompanyInsightsSearch
object
Company insights by type request resource.
2 properties
2 required
CompanyInsightsByTypeRequest
object
Request model for retrieving company insights by type.
1 property
1 required
SimilarCompanyAttributes
object
Attributes describing a single similar company.
7 properties
7 required
CompanyLookalike
object
Resource model for a company lookalike result.
3 properties
3 required
CompanyLookalikesResponse
object
Response model for company lookalikes
1 property
1 required
UseCaseType
string
Type of use case for contact recommendations.
ContactRecommendationAttributes
object
Attributes for a contact recommendation entity.
4 properties
3 required
SourceType
string
Source interaction type used to generate contact recommendations.
ExplainabilityMetadata
object
Explainability metadata for a contact recommendation.
3 properties
ContactRecommendation
object
Contact recommendation resource.
4 properties
3 required
ContactRecommendationResponse
object
Response model for contact recommendations.
1 property
1 required
ContactLookalikeAttributes
object
Attributes for a contact lookalike entity.
3 properties
3 required
LookalikeMetadata
object
Metadata for a lookalike contact entity.
2 properties
2 required
ContactLookalike
object
Contact lookalikes resource
4 properties
3 required
ContactLookalikeResponse
object
Response model for contact lookalikes.
1 property
1 required
GtmConfigSourceType
string
Source type indicating how a GTM configuration record was created or last modified. Used across all customer-level entities for audit provenance tracking. When…
CustomFieldItem
object
Schema for a single custom field item.
3 properties
2 required
CustomerBuyerPersonaAttributes
object
Attributes that define a customer buyer persona — a profile representing a type of buyer that the customer's sales team targets. Buyer personas capture who the…
8 properties
GtmConfigAuditFields
object
Common audit fields present on all customer-level GTM configuration entities. These fields track the full lifecycle of a record including creation, modificatio…
6 properties
CustomerBuyerPersona
object
Customer Buyer Persona resource.
4 properties
3 required
CustomerBuyerPersonaListResponse
object
API model for a list of customer buyer personas.
1 property
1 required
CustomerBuyerPersonaModel
object
API model for a single customer buyer persona.
1 property
1 required
CustomerBuyerPersonaUpsert
object
Customer Buyer Persona resource for upsert operations.
1 property
1 required
CustomerCompetitorAttributes
object
Attributes that define a Customer Competitor — a company that competes with the customer in the market.
10 properties
CustomerCompetitor
object
Customer Competitor resource.
4 properties
3 required
CustomerCompetitorListResponse
object
API model for a list of Customer Competitors.
1 property
1 required
CustomerCompetitorModel
object
API model for a single Customer Competitor.
1 property
1 required
CustomerCompetitorUpsert
object
Customer Competitor resource for upsert operations.
1 property
1 required
IdealCompanySegmentAttributes
object
Attributes that define an ideal company segment/Ideal Customer Profile. Ideal company segments/Ideal Customer Profile describe the types of companies a custome…
4 properties
IdealCompanySegment
object
Ideal Customer Profile resource.
4 properties
3 required
IdealCompanySegmentListResponse
object
API model for a list of Ideal Customer Profiles.
1 property
1 required
IdealCompanySegmentModel
object
API model for a single Ideal Customer Profile.
1 property
1 required
IdealCompanySegmentUpsert
object
Ideal Customer Profile resource for upsert operations.
1 property
1 required
CustomerSettingsAttributes
object
Attributes defining customer-level settings and configuration
6 properties
CustomerSettings
object
Customer Settings resource wrapping attributes in JSON:API format.
4 properties
3 required
CustomerSettingsModel
object
JSON:API response containing the customer settings singleton.
1 property
1 required
CustomerSettingsCreate
object
Customer Settings resource wrapping attributes in JSON:API format.
2 properties
2 required
CustomerSettingsModelCreate
object
JSON:API response containing the customer settings singleton.
1 property
1 required
OrganizationOfferingAttributes
object
Attributes that define a Product or Service — the discrete products or services provided by a customer's company. Products or services form the foundation of a…
11 properties
OrganizationOffering
object
Product or Service resource.
4 properties
3 required
OrganizationOfferingListResponse
object
API model for a list of products or services.
1 property
1 required
OrganizationOfferingModel
object
API model for a single product or service.
1 property
1 required
OrganizationOfferingUpsert
object
Product or Service resource for upsert operations.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ZoomInfo 7
Other APIs ZoomInfo publishes across the network.
Agent API
Data API
Data Quality API
Studio API
Marketing API
Platform API
Vertical Datasets API
Where this information came from
This is an independent, third-party profile of Copilot 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.