GTM data-model metadata and records — list entities, introspect their fields and upsert records; upsert, read and delete content-interaction engagements; list, execute and poll workflows; and read the caller's entitlements.
{"openapi":"3.0.0","info":{"title":"Platform API V1","version":"1.0","contact":{"name":"ZoomInfo Customer Support","email":"help@zoominfo.com"},"description":"The Platform API"},"tags":[{"name":"entities"},{"name":"Engagements"},{"name":"Workflows"},{"name":"Entitlements"}],"paths":{"/platform/v1/metadata/entities":{"get":{"operationId":"EntitiesController_getEntitiesList","summary":"Get GTM entities list","description":"Retrieve a list of all GTM data model entities available to your organization","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GtmEntitiesListResponse"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["entities"],"security":[{"OAuth2Auth":["api:gtm-data-model:read"]}]}},"/platform/v1/metadata/entities/{entityName}/fields":{"get":{"operationId":"EntitiesController_getEntityFields","summary":"Get GTM entity fields","description":"Retrieve detailed metadata and field definitions for a specific GTM entity","parameters":[{"name":"entityName","in":"path","required":true,"description":"The unique identifier of the GTM entity. Use the entityName from the entities metadata endpoint.","schema":{"$ref":"#/components/schemas/EntityNames"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GtmEntityFieldsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["entities"],"security":[{"OAuth2Auth":["api:gtm-data-model:read"]}]}},"/platform/v1/entities/{entityName}":{"post":{"operationId":"EntitiesController_upsertEntitiesRecords","summary":"Upsert GTM entity records","description":"Create or update entity records in the GTM data model","parameters":[{"name":"entityName","in":"path","required":true,"description":"The unique identifier of the GTM entity.","schema":{"$ref":"#/components/schemas/EntityNames"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpsertResponse"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["entities"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpsertDataPayload"}}},"description":"Collection of entity records to create or update in the GTM data model"},"security":[{"OAuth2Auth":["api:gtm-data-model:manage"]}],"x-additional-content-types":["application/json"]}},"/platform/v1/engagements/content-interactions":{"post":{"operationId":"EngagementsController_upsertContentInteractions","summary":"Upsert Content Interactions","description":"Create or update content interaction engagement records","parameters":[],"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ContentInteractionUpsertResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Engagements"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ContentInteractionUpsertRequest"}}},"description":"Content interaction engagement data to create or update (supports single or multiple engagements)"},"security":[{"OAuth2Auth":["api:gtm-data-model:manage"]}],"x-additional-content-types":["application/json"]}},"/platform/v1/engagements/content-interactions/{id}":{"get":{"operationId":"EngagementsController_getContentInteractionEngagement","summary":"Get content interaction","description":"Retrieve a specific content interaction engagement by ID","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the content interaction engagement","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ContentInteractionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Engagements"],"security":[{"OAuth2Auth":["api:gtm-data-model:read"]}]},"delete":{"operationId":"EngagementsController_deleteContentInteractionEngagement","summary":"Delete content interaction","description":"Delete a content interaction engagement record","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the content interaction engagement to delete","schema":{"type":"string"}}],"responses":{"204":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"nullable":true}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Engagements"],"security":[{"OAuth2Auth":["api:gtm-data-model:manage"]}]}},"/platform/v1/workflows":{"get":{"operationId":"WorkflowsController_getWorkflows","summary":"Get workflows list","description":"Get a list of workflows with optional filters and pagination","parameters":[{"name":"page[size]","in":"query","required":false,"description":"Number of items per page","schema":{"type":"integer","format":"int32"},"explode":false},{"name":"page[number]","in":"query","required":false,"description":"Page number for pagination","schema":{"type":"integer","format":"int32"},"explode":false},{"name":"sort","in":"query","required":false,"description":"Valid values are name, createdAt, updatedAt. Add minus sign ('-') for descending order","schema":{"type":"string"},"explode":false},{"name":"filter[runnableOnDemand]","in":"query","required":false,"description":"Filter by workflows that can be run on demand","schema":{"type":"boolean"},"explode":false},{"name":"filter[active]","in":"query","required":false,"description":"Filter by active workflows","schema":{"type":"boolean"},"explode":false},{"name":"filter[name]","in":"query","required":false,"description":"Filter by a workflow's name","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/WorkflowsListResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Workflows"],"security":[{"OAuth2Auth":["api:workflows:read","api:workflows:execute"]}],"x-api-scope-requirement":"ANY_REQUIRED"}},"/platform/v1/workflows/{id}/actions/execute":{"post":{"operationId":"WorkflowsController_executeWorkflow","summary":"Execute workflow","description":"Execute a workflow","parameters":[{"name":"id","in":"path","required":true,"description":"Unique identifier of the workflow to execute","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/WorkflowExecutionResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Workflows"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ExecuteWorkflowRequestBody"}}},"description":"Execution request body"},"security":[{"OAuth2Auth":["api:workflows:execute"]}],"x-additional-content-types":["application/json"]}},"/platform/v1/workflows/executions/{id}":{"get":{"operationId":"WorkflowsController_getExecutionStatus","summary":"Get execution status","description":"Get the status of a workflow execution","parameters":[{"name":"id","in":"path","required":true,"description":"Unique identifier of the execution","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/WorkflowExecutionResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Workflows"],"security":[{"OAuth2Auth":["api:workflows:execute"]}]}},"/platform/v1/entitlements":{"get":{"operationId":"EntitlementsController_getEntitlements","summary":"Get user entitlements","description":"Retrieve user entitlements filtered by admin status and role type.","parameters":[{"name":"filter[admin]","in":"query","required":true,"description":"Whether to retrieve admin entitlements, admin entitlements are only available to users with admin privileges, in the format of adm:roleCode, e.g. adm:fea:api.","schema":{"type":"boolean"},"explode":false},{"name":"filter[roleType]","in":"query","required":true,"description":"The role type to filter by.","schema":{"$ref":"#/components/schemas/RoleType"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/EntitlementsResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Entitlements"],"security":[{"OAuth2Auth":["api:entitlement:read"]}]}}},"security":[{"OAuth2Auth":[]}],"components":{"schemas":{"GtmEntityAssociation":{"type":"object","required":["associatedEntity","associatedFieldName"],"properties":{"associatedEntity":{"type":"string","description":"The name of the entity that this association points to"},"associatedFieldName":{"type":"string","description":"The field name in the associated entity that establishes the relationship"}},"description":"Represents a relationship between GTM entities, defining how one entity connects to another through specific field associations."},"GtmEntityAttributes":{"type":"object","required":["entityName","displayName","description","associations"],"properties":{"entityName":{"type":"string","description":"The unique identifier name of the entity within the GTM data model"},"displayName":{"type":"string","description":"The human-readable name of the entity"},"description":{"type":"string","description":"A detailed description explaining the purpose and usage of this entity"},"associations":{"type":"array","items":{"$ref":"#/components/schemas/GtmEntityAssociation"},"description":"Collection of associations that define how this entity relates to other entities in the data model"}},"description":"Core attributes that define a GTM data model entity, including its identity, relationships, and metadata."},"GtmEntity":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"GtmEntity","pattern":"GtmEntity"},"attributes":{"allOf":[{"$ref":"#/components/schemas/GtmEntityAttributes"}],"description":"The attributes defining the resource"}},"description":"Represents a GTM data model entity with its core attributes and relationships."},"GtmEntitiesListResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GtmEntity"},"description":"The primary data of the document"}},"description":"Response model containing a collection of GTM entities available in the data model."},"ZoomInfo.Core.Foundations.ErrorSourceModel":{"type":"object","properties":{"cookie":{"type":"string","description":"Identifies the cookie name that caused the issue"},"header":{"type":"string","description":"Identifies the header name that caused the error"},"pointer":{"type":"string","description":"An RFC 6901 compliant JSON pointer to the entity in the request body that caused the error"},"parameter":{"type":"string","description":"The name of the path or query parameter that caused the error"}}},"ZoomInfo.Core.Foundations.ErrorModel":{"type":"object","required":["id","code","status"],"properties":{"id":{"type":"string","description":"The unique id used to identify this specific error instance"},"code":{"type":"string","description":"The error code describing the error category. A full list of error codes can be found in the documentation for each service"},"detail":{"type":"string","description":"Message containing the specific details about this occurrence of the error"},"source":{"allOf":[{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorSourceModel"}],"description":"An optional object identifying which part of the request caused the error"},"status":{"type":"string","description":"The HTTP status code for the error"},"title":{"type":"string","description":"The error name that describes this type of error"}},"description":"The object describing a specific error from the API"},"ZoomInfo.Core.Foundations.ErrorResponseModel":{"type":"object","required":["errors"],"properties":{"detail":{"type":"string","description":"A high-level detail of the error(s) that occurred during the request"},"title":{"type":"string","description":"A high-level summary of the error(s) detected"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorModel"},"description":"The list of errors raised during the request"}},"description":"The standard error response body model for the ZoomInfo API."},"EntityNames":{"type":"string","enum":["account","contact","user"]},"GtmEntityFieldAttributes":{"type":"object","required":["name","displayName","dataType","required","fieldType","description"],"properties":{"name":{"type":"string","description":"The unique identifier name of the field"},"displayName":{"type":"string","description":"The human-readable name of the field"},"dataType":{"type":"string","description":"The data type of the field"},"required":{"type":"boolean","description":"Indicates whether this field is required"},"fieldType":{"type":"string","description":"The classification type of the field"},"description":{"type":"string","description":"A description explaining the purpose of this field"},"pickListValues":{"type":"array","items":{"type":"string"},"description":"Available predefined values for fields with limited options"},"reference":{"type":"string","description":"Reference to another entity or field"}},"description":"Attributes that define the characteristics and metadata of a field within a GTM entity."},"GtmEntityField":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"GtmEntityField","pattern":"GtmEntityField"},"attributes":{"allOf":[{"$ref":"#/components/schemas/GtmEntityFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Represents a field definition within a GTM entity, containing metadata about the field's characteristics and constraints."},"GtmEntityFieldsResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GtmEntityField"},"description":"The primary data of the document"}},"description":"Response model containing a collection of GTM entity field definitions."},"GtmModelAttributes":{"type":"object","additionalProperties":{},"description":"Attributes for GTM model records."},"UpsertRecord":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"UpsertRecord","pattern":"UpsertRecord"},"attributes":{"allOf":[{"$ref":"#/components/schemas/GtmModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Represents a record. that will be created or updated."},"UpsertResultModel":{"type":"object","required":["recordsProcessed","recordsSuccessful","recordsFailed","processedRecords"],"properties":{"recordsProcessed":{"type":"number","description":"recordsProcessed"},"recordsSuccessful":{"type":"number","description":"recordsSuccessful"},"recordsFailed":{"type":"number","description":"recordsFailed"},"processedRecords":{"type":"array","items":{"$ref":"#/components/schemas/UpsertRecord"},"description":"processedRecords"}},"description":"UpsertResultModel"},"GtmResponseModel":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"GtmResponseModel","pattern":"GtmResponseModel"},"attributes":{"allOf":[{"$ref":"#/components/schemas/UpsertResultModel"}],"description":"The attributes defining the resource"}},"description":"GtmResponseModel"},"UpsertResponse":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/GtmResponseModel"}],"description":"The primary data of the document"}},"description":"Response model containing the results of GTM model record upsert operations."},"UpsertDataPayload":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UpsertRecord"},"description":"The primary data of the document"}},"description":"Represents an entity that contains records collection."},"Channel":{"type":"string","enum":["Website","Email"]},"InteractionType":{"type":"string","enum":["Click","Save","Send","Sign","Submit","View"]},"ContentType":{"type":"string","enum":["Demo","Document","Email","Form","Video","Website"]},"Status":{"type":"string","enum":["Completed"]},"ParticipantAttributes":{"type":"object","required":["companyDomain"],"properties":{"participantId":{"type":"string","description":"Unique participant identifier"},"email":{"type":"string","description":"Email address"},"phoneNumber":{"type":"string","description":"Phone number"},"ipAddress":{"type":"string","description":"IP address"},"name":{"type":"string","description":"Full name"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"title":{"type":"string","description":"Job title"},"seniority":{"type":"string","description":"Seniority level"},"companyDomain":{"type":"string","description":"Company domain"},"companyName":{"type":"string","description":"Company name"},"ziPersonId":{"type":"string","description":"ZoomInfo person ID","readOnly":true},"ziCompanyId":{"type":"string","description":"ZoomInfo company ID","readOnly":true}},"description":"Participant model with common properties."},"ContentInteractionAttributes":{"type":"object","required":["engagementId","instanceId","channel","interactionType","contentType","actionPerformedAt","status","participant"],"properties":{"engagementId":{"type":"string","description":"Unique content interaction identifier"},"instanceId":{"type":"string","description":"Unique identifier of the customer's organization/tenant/instance in the external platform where the data originated (e.g. unique CRM Organization Id)"},"instanceUrl":{"type":"string","description":"Unique URL of the customer's organization/tenant/instance in the external platform where the data originated (e.g. unique CRM Organization Url)"},"duration":{"type":"integer","format":"int32","description":"Length of interaction in seconds (if applicable)"},"interactionProvider":{"type":"string","description":"Name of the system where the interaction data originated","readOnly":true},"channel":{"allOf":[{"$ref":"#/components/schemas/Channel"}],"description":"Source or medium through which the interaction occurred"},"interactionDetails":{"type":"object","additionalProperties":{},"description":"Include all attributes for this interaction that do not fit into the ContentInteraction schema (as key-value pairs)"},"interactionType":{"allOf":[{"$ref":"#/components/schemas/InteractionType"}],"description":"Specific action performed during the interaction. Note: When interactionType = Send, email sends (contentType = Email) are not accepted here — email send events must be submitted via the dedicated Email object."},"contentType":{"allOf":[{"$ref":"#/components/schemas/ContentType"}],"description":"Category or format of the content that received the interaction. Note: Email Sends (interactionType = Send and contentType = Email) are not accepted here — email send events must be submitted via the dedicated Email object."},"actionPerformedAt":{"type":"string","description":"Timestamp when the interaction started (if duration is present, this is the start time)"},"endedAt":{"type":"string","description":"Timestamp when the interaction ended (can be calculated from actionPerformedAt + duration if not explicitly provided)"},"targetUrl":{"type":"string","description":"Target URL"},"targetName":{"type":"string","description":"Target name"},"status":{"allOf":[{"$ref":"#/components/schemas/Status"}],"description":"Interaction status"},"participant":{"allOf":[{"$ref":"#/components/schemas/ParticipantAttributes"}],"description":"The participant associated with this content interaction"}},"description":"Content interaction engagement record attributes"},"ContentInteraction":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ContentInteraction","pattern":"ContentInteraction"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ContentInteractionAttributes"}],"description":"The attributes defining the resource"}},"description":"Content interaction model"},"UpsertResponseMeta":{"type":"object","required":["timestamp","processingTime","recordsProcessed","recordsSuccessful","recordsFailed"],"properties":{"timestamp":{"type":"string","description":"Response timestamp"},"processingTime":{"type":"integer","format":"int64","description":"Processing time in milliseconds"},"recordsProcessed":{"type":"integer","format":"int32","description":"Number of records processed"},"recordsSuccessful":{"type":"integer","format":"int32","description":"Number of records successfully processed"},"recordsFailed":{"type":"integer","format":"int32","description":"Number of records that failed processing"}},"description":"API response meta information for upsert operations"},"ContentInteractionUpsertResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContentInteraction"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/UpsertResponseMeta"}],"description":"Non-standard meta information about the document"}},"description":"Response model for content interaction engagement upsert operations"},"ContentInteractionCreateItem":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"ContentInteraction","pattern":"ContentInteraction"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ContentInteractionAttributes"}],"description":"The attributes defining the resource"}},"description":"Content interaction model"},"ContentInteractionUpsertRequest":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContentInteractionCreateItem"},"description":"The primary data of the document"}},"description":"Model for creating multiple content interaction engagements"},"ContentInteractionResponse":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ContentInteraction"}],"description":"The primary data of the document"}},"description":"Response model for getting a specific content interaction"},"WorkflowAttributes":{"type":"object","required":["name","active","runnableOnDemand","lastUpdated","createdAt"],"properties":{"name":{"type":"string","description":"Name of the workflow"},"active":{"type":"boolean","description":"Activation status of the workflow"},"runnableOnDemand":{"type":"boolean","description":"Whether the workflow can be executed on demand"},"lastUpdated":{"type":"string","format":"date-time","description":"Last update timestamp","readOnly":true},"createdAt":{"type":"string","format":"date-time","description":"Created timestamp","readOnly":true}},"description":"Attributes for a workflow in the list response"},"Workflow":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Workflow","pattern":"Workflow"},"attributes":{"allOf":[{"$ref":"#/components/schemas/WorkflowAttributes"}],"description":"The attributes defining the resource"}},"description":"Workflow resource model"},"GetWorkflowsMeta":{"type":"object","required":["page","pageSize","totalCount"],"properties":{"page":{"type":"integer","format":"uint32","description":"The current page of workflows being returned"},"pageSize":{"type":"integer","format":"uint32","description":"The page size as specified by the request"},"totalCount":{"type":"integer","format":"uint32","description":"The total count of workflows within the current search parameters"}},"description":"Metadata for the current page of workflows returned"},"GetWorkflowsLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri","description":"A link to the first page of data"},"last":{"type":"string","format":"uri","description":"A link to the last page of data"},"prev":{"type":"string","format":"uri","description":"A link to the previous page of data"},"next":{"type":"string","format":"uri","description":"A link to the next page of data"}},"description":"Links describing the various workflows paging options"},"WorkflowsListResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Workflow"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/GetWorkflowsMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/GetWorkflowsLinks"}],"description":"Links related to the primary data"}},"description":"Response containing a list of workflows"},"WorkflowExecutionAttributes":{"type":"object","required":["workflowId","status"],"properties":{"workflowId":{"type":"string","description":"Identifier of the workflow being executed"},"status":{"type":"string","description":"Current status of the execution"}},"description":"Attributes for workflow execution response"},"WorkflowExecution":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"WorkflowExecution","pattern":"WorkflowExecution"},"attributes":{"allOf":[{"$ref":"#/components/schemas/WorkflowExecutionAttributes"}],"description":"The attributes defining the resource"}},"description":"Workflow execution response model"},"WorkflowExecutionResponse":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/WorkflowExecution"}],"description":"The primary data of the document"}},"description":"Response for workflow execution"},"ExecuteWorkflowAttributes":{"type":"object","properties":{"callback_url":{"type":"string","description":"URL to call back with execution results"}},"description":"Attributes for workflow execution request"},"ExecuteWorkflowRequest":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"ExecuteWorkflowRe
# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoominfo/refs/heads/main/openapi/zoominfo-gtm-platform-v1-openapi.json