# Copilot API

**Canonical:** https://apis.io/apis/gtm/copilot-api/  
**Provider:** ZoomInfo — https://apis.io/providers/gtm/  
**Base URL:** https://api.gtm.ai/copilot  
**Documentation:** https://docs.gtm.ai/reference/copilot

Copilot API is one of 8 APIs that [ZoomInfo](https://apis.io/providers/gtm/) publishes on the [APIs.io](https://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.

Copilot API V1

## Operations (33)

| Method | Path | Summary |
|---|---|---|
| POST | `/copilot/v1/companies/insights` | Get insights by type |
| GET | `/copilot/v1/companies/lookalikes` | Find Similar Companies |
| GET | `/copilot/v1/companies/{companyId}/account-summary` | Get Account Summary |
| POST | `/copilot/v1/companies/{companyId}/account-summary/actions/ask` | Ask Account Summary Question |
| GET | `/copilot/v1/contacts/lookalikes` | Get Contact Lookalikes |
| GET | `/copilot/v1/contacts/recommendations` | Get Contact Recommendations |
| 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 |
| 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 |
| GET | `/copilot/v1/customer-settings` | Get Customer Settings |
| POST | `/copilot/v1/customer-settings` | Upsert Customer Settings |
| DELETE | `/copilot/v1/customer-settings` | Delete Customer Settings |
| 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 |
| 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 |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gtm/refs/heads/main/openapi/gtm-copilot-api-v1-api-openapi.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gtm/refs/heads/main/json-schema/gtm-customer-buyer-persona-upsert-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gtm/refs/heads/main/json-schema/gtm-ideal-company-segment-upsert-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gtm/refs/heads/main/json-schema/gtm-organization-offering-upsert-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gtm/refs/heads/main/json-schema/gtm-customer-competitor-upsert-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gtm/refs/heads/main/json-schema/gtm-company-insights-by-type-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gtm/refs/heads/main/json-schema/gtm-account-summary-question-request-schema.json

## Other ZoomInfo APIs (7)

- [Agent API](https://apis.io/apis/gtm/agent-api/)
- [Data API](https://apis.io/apis/gtm/data-api/)
- [Data Quality API](https://apis.io/apis/gtm/data-quality-api/)
- [Studio API](https://apis.io/apis/gtm/studio-api/)
- [Marketing API](https://apis.io/apis/gtm/marketing-api/)
- [Platform API](https://apis.io/apis/gtm/platform-api/)
- [Vertical Datasets API](https://apis.io/apis/gtm/vertical-datasets-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/gtm/copilot-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/gtm/.