The identity and technical contract details declared by the specification.
FolderJsonApiModelCreate
object
JSON API model for Folder.
1 property
1 required
ReadAudienceAttributes
object
Audience model representing audience details.
9 properties
4 required
GetRowsAttributes
object
Attributes defining the request parameters for retrieving Rows
2 properties
CellState
string
Processing state of a cell value within a row. Indicates whether enrichment has run and what the outcome was.
FolderJsonApiList
object
JSON API model for Folder List.
3 properties
1 required
ReadColumnAttributes
object
Base attributes shared by all column types in an audience.
15 properties
7 required
RowAsyncJob
object
Row async job response resource.
2 properties
2 required
JobResponseStatus
object
Current status and progress of an asynchronous job.
2 properties
1 required
ColumnMeta
object
Metadata for Column model.
6 properties
6 required
EnrichAudienceAttributes
object
Defines the scope and targets for an enrichment operation. - If scope is AUDIENCE, enriches all rows; rows and columns are optional. - If scope is ROW, enriche…
3 properties
1 required
UpdateFolderJsonApiModel
object
JSON API model for Folder.
1 property
ReadAudience
object
Audience read request resource.
4 properties
3 required
ReadAudienceDetailJsonApiModel
object
JSON API model for Audience detail responses.
1 property
1 required
AudienceFilterMetadataJsonApiModel
object
JSON API model for Audience filter metadata request.
1 property
1 required
AiColumn
object
Column model representing an AI column — values are generated by AI. The optional tool determines which AI capability is used.
13 properties
8 required
ZoomInfo.Core.Foundations.ErrorSourceModel
object
4 properties
Page
object
Page details for paginated responses.
2 properties
2 required
ColumnInputType
string
Defines the type of context input used for AI column generation.
AudienceJsonApiModel
object
JSON API model for Audience.
1 property
1 required
CellErrorDetails
object
Describes an error that occurred during enrichment for a specific cell.
3 properties
3 required
Row
object
Attributes defining Row.
3 properties
3 required
FormulaColumn
object
Column model representing a formula column — values are generated by a formula prompt. Requires only name and prompt.
11 properties
8 required
ReadAudienceJsonApiModel
object
JSON API model for Audience.
1 property
1 required
StringArrayItem
array
Represents a list of string values for a field
GetRowsJsonApiModel
object
JSON API model for get Rows.
3 properties
1 required
EnrichmentScope
string
Specifies the scope of enrichment operation: AUDIENCE enriches all rows, ROW enriches specific rows by ID.
AudienceMeta
object
Metadata for Audience model.
6 properties
6 required
FolderAttributes
object
Attributes for a folder that organizes audiences in GTM Studio.
5 properties
1 required
BulkRowUpsertListApiModel
object
JSON API model for bulk upsert Row request. Row id is optional — omit to create, provide to update.
1 property
1 required
FolderCreate
object
Folder request resource.
2 properties
2 required
FilterMetadata
object
Filter metadata for a single column — lists which operators are valid and their constraints.
3 properties
3 required
RowJsonApiModel
object
JSON API model for Row.
1 property
1 required
AudienceUpdateJsonApiModel
object
JSON API model for Audience.
1 property
1 required
ReadAudienceDetailAttributes
object
Audience attributes returned by detail endpoints.
10 properties
4 required
ReadColumn
object
Column Read resource model.
4 properties
3 required
UpdateFolderAttributes
object
Attributes for a folder that organizes audiences in GTM Studio.
4 properties
FoldersPagingLinks
object
Paging links for Folder list.
4 properties
CustomAudienceAttributes
object
Audience model representing audience details.
8 properties
3 required
RowAsyncJobJsonApiModel
object
JSON API model for Row async job response.
1 property
1 required
ZoomInfo.Core.Foundations.ErrorResponseModel
object
The standard error response body model for the ZoomInfo API.
3 properties
1 required
EnrichJob
object
Enrich async job response resource.
2 properties
2 required
FilterMetadataAttributes
object
Filter metadata model representing the filter configuration and types allowed for each column.
1 property
1 required
ReadAudienceDetail
object
Audience read detail request resource.
4 properties
3 required
ColumnAttributes
object
CUSTOM - Column model representing static column in an audience. FORMULA - Column model representing a formula-based column where values are generated from a p…
UpdateFolder
object
Folder request resource.
2 properties
RowAttributes
object
Contains all cell data for a row, organized as an array of CellDetails objects — one per column.
1 property
1 required
UpsertMatchCriteriaRequestJsonApiModel
object
JSON API model for upsert match criteria request.
1 property
1 required
ContactsEmploymentHistory
object
Employment history criteria used in contact search.
2 properties
2 required
FolderJsonApiModel
object
JSON API model for Folder.
1 property
1 required
ReadColumnJsonApiModel
object
JSON API model for read Column.
1 property
1 required
ZoomInfo.Core.Foundations.ErrorModel
object
The object describing a specific error from the API
6 properties
3 required
FormulaExpressionLanguage
string
Supported expression languages for formula columns.
ZoomInfoSearchCriteria
object
ZoomInfo search criteria configuration for audience targeting. At least one of companySearch or contactSearch must be provided. - For COMPANY audiences, compan…
2 properties
NumericArray
array
Represents a list of numeric values for a field
RunStatus
string
Terminal and in-progress states for an asynchronous job.
ColumnAttributesForAudienceCreate
object
Only Some columns can be created while creating an audience, so we are having a separate model to represent it For example ZoomInfo Match columns are created b…
EnrichJobJsonApiModel
object
JSON API model for Enrich job response.
1 property
1 required
EnrichAudience
object
Audience enrichment request resource.
2 properties
2 required
ReadColumnListJsonApiModel
object
JSON API model for read Column.
1 property
1 required
ColumnContextInput
object
Defines a context input for an AI column, referencing either an existing column in the audience or a knowledge base attribute. This context is used to inform t…
2 properties
2 required
ZoomInfo.SearchCriteria.CompanySearch
object
Company search configuration.
62 properties
CellDetails
object
Defines the data and processing state for a single cell within a row.
4 properties
3 required
AudienceFilterMetadata
object
Audience filter metadata request resource.
3 properties
3 required
ZoomInfoPublicApiAudienceAttributes
object
Audience model representing audience details.
8 properties
3 required
GenericFilterGroupForAudience
object
Represents a group of filters combined with a logical operator (AND/OR)
2 properties
1 required
ColumnJsonApiModel
object
JSON API model for create Column.
1 property
1 required
MatchCriteria
object
Defines a single match criterion that maps an audience column to a ZoomInfo attribute for row matching during enrichment.
2 properties
2 required
StringArray
array
Represents a list of string values for a field
ColumnDataDependency
object
Defines a supported data dependency for a selected AI column type.
5 properties
4 required
JobStatusResponse
object
Job status resource.
3 properties
3 required
RowUpsertListApiModel
object
JSON API model for synchronous upsert Row request (≤ 50 rows). Row id is optional — omit to create, provide to update.
1 property
1 required
UpdateAudience
object
Audience request resource.
2 properties
2 required
CreateColumnDuringAudienceCreationCreateItem
object
Column Create request resource model during audience creation. This model only includes attributes that are allowed during the creation of an audience, eg. Exc…
3 properties
2 required
FolderMeta
object
Metadata for Folder model.
6 properties
6 required
AudiencesJsonApiList
object
JSON API model for Audience list.
3 properties
1 required
RowSearchPagingLinks
object
Paging links for get Rows.
4 properties
ZoominfoMatchColumn
object
Column model representing a ZoomInfo match column — values are populated by matching rows against ZoomInfo's database using defined criteria. This Column accep…
10 properties
8 required
GenericFilterFieldForAudience
object
Represents a single filter field with its associated properties
4 properties
4 required
CreateAudienceResponseAttributes
object
Audience attributes returned upon creation
10 properties
4 required
Column
object
Column Create request resource.
2 properties
2 required
JobStatusResponseJsonApiModel
object
JSON API model for Job status response.
1 property
1 required
GenericFilterOperator
string
AudiencesPagingLinks
object
Paging links for Audience list.
4 properties
ColumnDataDependencyList
object
Resource model for list of column data dependencies supported for a specific column type.
2 properties
2 required
ColumnDataDependencyListModel
object
JSON API model for list of column data dependencies supported for a specific column type.
1 property
1 required
UpsertRow
object
Row attributes for upsert operations. Identical to RowAttributes but id is optional — omit it to create a new row, provide it to update an existing one.
3 properties
2 required
UpdateColumn
object
Column update request resource.
2 properties
Pagination
object
Pagination details for paginated responses.
2 properties
2 required
AudienceType
string
Determines the record type the audience holds. Set at creation and cannot be changed.
UpsertMatchCriteriaRequest
object
Upsert match criteria request resource.
3 properties
3 required
ScriptConfiguration
object
Optional script configuration returned for FORMULA columns. Contains the generated expression and its language.
2 properties
2 required
Folder
object
Folder request resource.
4 properties
3 required
StaticColumn
object
Column model representing static column in an audience.
10 properties
8 required
FilterOperatorConfig
object
Configuration constraints for a single filter operator on a column.
4 properties
2 required
NumericArrayItem
array
Represents a list of numeric values for a field
CreateAudienceResponseJsonApiModel
object
JSON API model for the Create Audience response.
1 property
1 required
UpdateAudienceAttributes
object
Audience model representing audience details.
4 properties
SourceOrigin
string
Indicates how the audience was originally populated. Read-only; set by the system based on the creation method.
AiTool
string
Defines AI tool names used by AI columns and data dependency discovery.
AudienceAttributes
object
Audience
object
Audience request resource.
2 properties
2 required
RowSearchJsonApiModel
object
JSON API model for get Rows request.
1 property
1 required
ZoomInfo.SearchCriteria.ContactSearch
object
Contact search configuration.
88 properties
RowSearch
object
Row Get request resource.
2 properties
2 required
CreateAudienceResponse
object
Audience response resource returned on creation.
4 properties
3 required
ColumnUpdateJsonApiModel
object
JSON API model for Column update.
1 property
UpsertRowsJsonApiModel
object
JSON API response for bulk row upsert. Returns created/updated rows in data[], matching the get row by ID response shape (includes state and errorDetails per c…
1 property
1 required
UpdateColumnAttributes
object
Base attributes shared by all column types in an audience.
3 properties
AudienceEnrichmentJsonApiModel
object
JSON API model for Audience enrichment request.
1 property
1 required
UpsertMatchCriteriaAttributes
object
Request attributes for upserting match criteria on the audience's designated match column. Match criteria define how audience column values are mapped to ZoomI…
1 property
DeleteRowJsonApiModel
object
Deleting Rows Request Models
1 property
1 required
RowIdentifier
object
Row Delete request resource.
2 properties
2 required
UploadStatus
string
The various status values for an audience member upload
GetAudiencesMeta
object
Metadata for the current page of audiences returned
3 properties
3 required
UploadOperationType
string
The type of upload
UploadField
string
Enumeration of allowed field names for records.
AudienceUploadCreate
object
ZoomInfo Audience Upload
2 properties
2 required
AudienceUploadAttributesCreate
object
Attributes defining an audience member upload
3 properties
3 required
AudienceModelUpdate
object
Response containing a single ZoomInfo Audience
1 property
1 required
AudienceUploadModel
object
Request/Response wrapper for a ZoomInfo Audience Upload
1 property
1 required
AudienceAttributes_2
object
Attributes defining a ZoomInfo Audience
3 properties
3 required
AudienceUploadAttributes
object
Attributes defining an audience member upload
5 properties
4 required
Audience_2
object
ZoomInfo Audience
3 properties
3 required
GetAudiencesResponse
object
A paged list of ZoomInfo Audiences
3 properties
1 required
AudienceUpdate
object
ZoomInfo Audience
3 properties
3 required
AudienceUploadModelCreate
object
Request/Response wrapper for a ZoomInfo Audience Upload
1 property
1 required
AudienceModelCreate
object
Response containing a single ZoomInfo Audience
1 property
1 required
AudienceCreate
object
ZoomInfo Audience
2 properties
2 required
AudienceAttributesUpdate
object
Attributes defining a ZoomInfo Audience
1 property
1 required
GetAudiencesLinks
object
Links describing the various audience paging options
3 properties
AudienceUpload
object
ZoomInfo Audience Upload
3 properties
3 required
AudienceModel
object
Response containing a single ZoomInfo Audience
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs ZoomInfo publishes across the network.