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

ZoomInfo Ideal Customer Profile API

The Ideal Customer Profile API from ZoomInfo — 4 operation(s) for ideal customer profile.

ZoomInfo Ideal Customer Profile API is one of 42 APIs that ZoomInfo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Ideal Customer Profile. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.zoominfo.com/gtm.

6 operations 4 paths 11 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.zoominfo.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

ZoomInfo Ideal Customer Profile 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 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Ideal Customer Profile 6
GET
/copilot/v1/ideal-company-profile
List Ideal Customer Profiles
CustomerIdealCompanySegmentInterface_listIdealCompanySegments → 200400401403429
POST
/copilot/v1/ideal-company-profile
Upsert Ideal Customer Profile
CustomerIdealCompanySegmentInterface_upsertIdealCompanySegment body → 200400401403422429
GET
/copilot/v1/ideal-company-profile/{segmentId}
Get an Ideal Customer Profile
CustomerIdealCompanySegmentInterface_getIdealCompanySegment 1 param → 200400401403404429
DELETE
/copilot/v1/ideal-company-profile/{segmentId}
Delete Ideal Customer Profile
CustomerIdealCompanySegmentInterface_deleteIdealCompanySegment 1 param → 204400401403404429
POST
/copilot/v1/ideal-company-profile/{segmentId}/actions/archive
Archive ICP
CustomerIdealCompanySegmentInterface_archiveIdealCompanySegment 1 param → 200400401403404429
POST
/copilot/v1/ideal-company-profile/{segmentId}/actions/unarchive
Unarchive ICP
CustomerIdealCompanySegmentInterface_unarchiveIdealCompanySegment 1 param → 200400401403404429

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ZoomInfo.Core.Foundations.ErrorModel (6 properties), GtmConfigAuditFields (6 properties), ZoomInfo.Core.Foundations.ErrorSourceModel (4 properties), IdealCompanySegmentAttributes (4 properties). Each schema is shown below with its type and property counts.

CustomFieldItem
object
Schema for a single custom field item.
3 properties 2 required
IdealCompanySegmentUpsert
object
Ideal Customer Profile 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
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
ZoomInfo.Core.Foundations.ErrorResponseModel
object
The standard error response body model for the ZoomInfo API.
3 properties 1 required
IdealCompanySegmentModel
object
API model for a single Ideal Customer Profile.
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…
IdealCompanySegmentListResponse
object
API model for a list of Ideal Customer Profiles.
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoominfo-ideal-customer-profile-api-openapi.yml Raw ↑

Other APIs ZoomInfo publishes across the network.

ZoomInfo Authentication API
ZoomInfo Bulk API
ZoomInfo Company Enrich API
ZoomInfo Company Location Enrich API
ZoomInfo Company Master Data Enrich API
ZoomInfo Company Search API
ZoomInfo Compliance API API
ZoomInfo Contact Enrich API
ZoomInfo Contact Search API
ZoomInfo Corporate Hierarchy Enrich API
ZoomInfo Hashtags Enrich API
ZoomInfo Intent Enrich API
Where this information came from

This is an independent, third-party profile of ZoomInfo Ideal Customer Profile 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.