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

Unify Data API

The Data API from Unify — 18 operation(s) for data.

Unify Data API is one of 4 APIs that Unify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, rate-limit docs, and authentication docs.

This API exposes 31 operations across 18 paths, and defines 80 schemas. It is described by OpenAPI 3.2.0, at version 1.

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

31 operations 18 paths 80 schemas 4 DELETE13 GET4 PATCH10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://api.unifyintent.com/analytics/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Unify Data API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 31

Across 18 paths, the API surfaces 31 operations — 4 DELETE, 13 GET, 4 PATCH, 10 POST. Each is listed below with its method, path, parameters, and response codes.

Data 31
POST
/data/v1/events/query-jobs
Create event query job
create_event_query_job body → 201400401429500
GET
/data/v1/events/query-jobs
List event query jobs
list_event_query_jobs 3 params → 200400401429500
GET
/data/v1/events/query-jobs/{job_id}
Get event query job
get_event_query_job 1 param → 200400401404429500
POST
/data/v1/events/query-jobs/{job_id}/cancel
Cancel event query job
cancel_event_query_job 1 param → 200400401404409429500
GET
/data/v1/events/query-jobs/{job_id}/results
Get event query job results
get_event_query_job_results 3 params → 200400401404409410413429
GET
/data/v1/objects
List objects
list_objects → 200400401500
POST
/data/v1/objects
Create object
create_object body → 201400401403409500
GET
/data/v1/objects/{object_name}
Get object
get_object 1 param → 200400401404500
PATCH
/data/v1/objects/{object_name}
Update object
update_object 1 param body → 200400401403404409500
DELETE
/data/v1/objects/{object_name}
Delete object
delete_object 1 param → 200400401403404500
GET
/data/v1/objects/{object_name}/attributes
List object attributes
list_object_attributes 1 param → 200400401404500
POST
/data/v1/objects/{object_name}/attributes
Create object attribute
create_object_attribute 1 param body → 201400401403404409500
GET
/data/v1/objects/{object_name}/attributes/{attribute_name}
Get object attribute
get_object_attribute 2 params → 200400401404500
PATCH
/data/v1/objects/{object_name}/attributes/{attribute_name}
Update object attribute
update_object_attribute 2 params body → 200400401403404409500
DELETE
/data/v1/objects/{object_name}/attributes/{attribute_name}
Delete object attribute
delete_object_attribute 2 params → 200400401403404500
GET
/data/v1/objects/{object_name}/attributes/{attribute_name}/options
List object attribute options
list_object_attribute_options 2 params → 200400401404500
POST
/data/v1/objects/{object_name}/attributes/{attribute_name}/options
Create object attribute option
create_object_attribute_option 2 params body → 201400401403404409500
GET
/data/v1/objects/{object_name}/attributes/{attribute_name}/options/{option_name}
Get object attribute option
get_object_attribute_option 3 params → 200400401404500
PATCH
/data/v1/objects/{object_name}/attributes/{attribute_name}/options/{option_name}
Update object attribute option
update_object_attribute_option 3 params body → 200400401403404409500
DELETE
/data/v1/objects/{object_name}/attributes/{attribute_name}/options/{option_name}
Delete object attribute option
delete_object_attribute_option 3 params → 200400401403404500
POST
/data/v1/objects/{object_name}/query-jobs
Create object record query job
create_object_record_query_job 1 param body → 201400401404429500
GET
/data/v1/objects/{object_name}/query-jobs
List object record query jobs
list_object_record_query_jobs 4 params → 200400401429500
GET
/data/v1/objects/{object_name}/query-jobs/{job_id}
Get object record query job
get_object_record_query_job 2 params → 200400401404429500
POST
/data/v1/objects/{object_name}/query-jobs/{job_id}/cancel
Cancel object record query job
cancel_object_record_query_job 2 params → 200400401404409429500
GET
/data/v1/objects/{object_name}/query-jobs/{job_id}/results
Get object record query job results
get_object_record_query_job_results 4 params → 200400401404409410413429
POST
/data/v1/objects/{object_name}/records
Create object record
create_object_record 2 params body → 201400401404409500503
POST
/data/v1/objects/{object_name}/records/find-unique
Find unique object record
find_unique_object_record 1 param body → 200400401404500
POST
/data/v1/objects/{object_name}/records/upsert
Upsert object record
upsert_object_record 2 params body → 200400401404409500503
GET
/data/v1/objects/{object_name}/records/{record_id}
Get object record
get_object_record 2 params → 200400401404500
PATCH
/data/v1/objects/{object_name}/records/{record_id}
Update object record
update_object_record 3 params body → 200400401404409500503
DELETE
/data/v1/objects/{object_name}/records/{record_id}
Delete object record
delete_object_record 2 params → 200400401404500503

Schemas 80

The contract defines 80 schemas that model the data the API accepts and returns. The most detailed are UObjects.UPersonAttributes (18 properties), UObjects.UCompanyAttributes (16 properties), UEvent (10 properties), UValues.UAddress (9 properties). Each schema is shown below with its type and property counts.

GetBulkApiJobResultsFailedResponse
object
Response returned when a Bulk API job failed and has no results.
CreateRecordRequest
object
Request body for creating a record.
1 property 1 required
BulkApiEventsQueryFilter
object
Filters accepted when querying events. Events are immutable, so the natural cursor is timestamp, which is also the only datetime field filterable here.
7 properties
UValues.UDecimal
number
Decimal value.
UObjects.UPerson
object
5 properties 5 required
UObjects.UAttributeOptionUpdateItem
object
Definition of an option for a SELECT or MULTISELECT attribute.
1 property 1 required
SearchRecordsSelect
object
Select the attributes to return for each record. Each key is an attribute API name on the queried object. A value of true returns the attribute directly, while…
SearchRecordsTimestampFilter
object
Bounds on a record metadata timestamp, expressed as ISO-8601 datetimes interpreted as UTC instants. At least one bound is required, and at most one lower (gt /…
4 properties
UObjects.UReferenceAttributeUpdate
object
Definition of a "reference" attribute on a Unify object.
3 properties 3 required
GetBulkApiJobSuccessResponse
object
Response returned when fetching a Bulk API job.
UObjects.UAttributeUpdate
Definition of an attribute on a Unify object.
UObjects.USelectAttributeUpdate
object
Definition of a "select" attribute on a Unify object.
1 property 1 required
SearchRecordsMetadataFilter
object
Filter records by base record timestamps (createdat / updatedat). Distinct from attribute where because these are record metadata rather than object attributes…
2 properties
UValues.UUuid
string
String UUIDv4 value.
UValues.UEmail
string
String value representing an email address.
GetBulkApiJobResultsPayloadTooLargeResponse
object
Response returned when a requested Bulk API results page is too large.
2 properties 2 required
CreateBulkApiJobSuccessResponse
object
Response returned when creating a Bulk API query job.
3 properties 3 required
GetBulkApiJobResultsCanceledResponse
object
Response returned when a Bulk API job was canceled and has no results.
CancelBulkApiJobNotCancelableResponse
object
Response returned when a Bulk API job is not cancelable.
BulkApiJob
object
Bulk API job representation.
7 properties 7 required
UValues.UMultiSelect
array
String array that contains strings from a specific set of allowed values.
SearchRecordsSortDirection
string
Direction in which to sort records.
UObjects.URelatedReferenceAttribute
object
3 properties 3 required
GetBulkApiJobResultsExpiredResponse
object
Response returned when Bulk API job results have expired.
2 properties 2 required
BulkApiObjectRecordsQuery
object
Query describing which object records to return and how to shape them.
4 properties 1 required
CreateBulkApiObjectRecordsJobObjectNotFoundResponse
object
Response returned when the object being queried cannot be found.
UValues.USelect
string
String value that matches one of a specific set of allowed values.
SearchRecordsWhere
object
Filter records by one or more attribute conditions. Each key is an attribute API name on the queried object. A value of { "equals": ... } matches the attribute…
UValues.UUrl
string
String value representing a web URL or internet domain.
UValues.UReferenceById
object
Reference to another object record by ID. This will find an existing record by its ID, and an error will be returned if the record does not exist.
1 property 1 required
UObjects.UAttribute
Definition of an attribute on a Unify object.
UObjects.UObjectUpdate
object
2 properties 2 required
CreateBulkApiEventsJobRequest
object
Request body for creating an events Bulk API query job.
1 property
UValues.UInteger
integer
Integer value.
UValues.UCountryCode
string
ISO 3166-1 alpha-2 country code.
UObjects.UObject
object
4 properties 4 required
UObjects.UMultiSelectAttribute
object
Definition of a "multi-select" attribute on a Unify object.
1 property 1 required
UValues.UAddress
object
Composite object representing a physical address.
9 properties
GetBulkApiJobResultsNotReadyResponse
object
Response returned when Bulk API job results are not ready yet.
UValues.UReferenceByUpsert
object
Reference to another object record by performing a nested upsert. At least one of create, createorupdate or createorupdateifempty must be provided, and all req…
6 properties 1 required
UValues.UText
string
String value.
UObjects.USelectAttribute
object
Definition of a "select" attribute on a Unify object.
1 property 1 required
UObjects.UMultiSelectAttributeUpdate
object
Definition of a "multi-select" attribute on a Unify object.
1 property 1 required
EventType
string
Canonical, source-agnostic event type.
UValues.UCountry
object
Composite object representing a country.
2 properties 2 required
UObjects.UCompanyAttributes
object
16 properties 1 required
UObjects.UAttributeOption
object
Definition of an option for a SELECT or MULTISELECT attribute.
2 properties 2 required
UResponses.BadRequestError
object
Validation error detail returned for bad request responses.
4 properties 1 required
SearchRecordsMetadataSortBy
object
Sort records by a base record field. Pairing a createdat / updatedat sort with the matching metadata filter enables incremental queries that page through every…
2 properties 2 required
UValues.UBoolean
boolean
Boolean value.
UObjects.UReferenceAttribute
object
Definition of a "reference" attribute on a Unify object.
3 properties 3 required
SearchRecordsMetadataSortField
string
Base record field to sort by.
UValues.UReferenceByMatch
object
Reference to another object record by match criteria. This will find an existing record using the provided match criteria, and null will be returned if no matc…
1 property 1 required
CancelBulkApiJobSuccessResponse
object
Response returned when canceling a Bulk API job.
2 properties 2 required
UValues.UPhoneNumber
string
String value representing a phone number.
UValues.UCurrencyCode
string
ISO 4217 currency code.
GetBulkApiJobNotFoundResponse
object
Response returned when a Bulk API job cannot be found.
BulkApiUuidFilter
object
Filter matching a resource by ID.
1 property 1 required
UObjects.UObjectProvider
string
Represents who created and manages an object in Unify. In most ways, all objects within the Unify platform behave the same way regardless of whether they are d…
UValues.UDatetime
string
String value representing a datetime.
BulkApiObjectRecordResult
object
A single object record result row from a query job. Mirrors UObjectRecord, but widens attributes to allow nested records: a selected scalar attribute is a UVal…
5 properties 5 required
UObjects.UPersonAttributes
object
18 properties 1 required
UValues.UDate
string
String value representing a date.
UValues.UCurrency
object
Composite object representing a currency value.
2 properties 2 required
BulkApiDatetimeRangeFilter
object
Datetime range filter. At least one bound must be provided. gt is mutually exclusive with gte, and lt is mutually exclusive with lte.
4 properties
UObjects.UReferenceCardinality
string
SearchRecordsNestedSelect
object
Select the attributes of a referenced record reached through a single-reference attribute.
1 property 1 required
UEvent
object
A flat, denormalized event row returned by an event Bulk API query job. Unlike object records, events are not wrapped in the object / attributes envelope. Page…
10 properties 10 required
BulkApiJobStatus
string
Status of an asynchronous Bulk API job.
ValidationMode
string
Validation mode to use when validating request data. strict validation will fail requests if any attribute fails validation, including unrecognized attributes.…
ListBulkApiJobsSuccessResponse
object
Response returned when listing Bulk API jobs.
2 properties 2 required
UpsertRecordRequest
object
Request body for upserting a record. At least one of create, createorupdate or createorupdateifempty must be provided, and all required attributes on the objec…
6 properties 1 required
SearchRecordsAttributeWhere
object
Filter records by attribute value. The equals value must match the type of the attribute being filtered.
1 property 1 required
FindUniqueRecordRequest
object
Request body for finding a unique record by attribute values.
1 property 1 required
UObjects.UCompany
object
5 properties 5 required
UValues.UValue
UObjects.UObjectName
string
The API name of an object, e.g. company, person, opportunity, or a custom object's API name.
CreateBulkApiObjectRecordsJobRequest
object
Request body for creating an object records Bulk API query job.
1 property 1 required
UpdateRecordRequest
object
Request body for updating a record.
1 property 1 required
UObjects.UAttributeOptionUpdate
object
Definition of an option for a SELECT or MULTISELECT attribute.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unify-data-api-openapi.yml Raw ↑

Other APIs Unify publishes across the network.

Unify Analytics Events API
Unify Sequences API
Unify Tasks API
Where this information came from

This is an independent, third-party profile of Unify Data 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.