Unify Data API
The Data API from Unify — 18 operation(s) for data.
Operations 31
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“How do I export all my website page, track and identify events from Unify in bulk?”
“Can I export only analytics events newer than a certain timestamp for an incremental sync?”
Tell an agent
Start an export job for all analytics events.
Start an analytics event export filtered by {filter}.
Ask an LLM
“Which analytics event export jobs have I started recently?”
“Can I see only the event export jobs that are still in progress?”
Tell an agent
List my analytics event export jobs.
Show event export jobs with status {status}.
GET
/data/v1/events/query-jobs/{job_id}
Check the status of an event export job · Get event query job
#
Ask an LLM
“Has my analytics event export job finished yet?”
“When does an event export job expire after I create it?”
Tell an agent
Check whether event export job {job_id} is finished.
Poll the status of analytics event export {job_id}.
POST
/data/v1/events/query-jobs/{job_id}/cancel
Cancel a running event export job · Cancel event query job
#
Ask an LLM
“Can I stop an analytics event export that is still running?”
“Which event export jobs are allowed to be canceled?”
Tell an agent destructive · confirm first
Cancel analytics event export job {job_id}.
Stop the in-progress event export {job_id}.
GET
/data/v1/events/query-jobs/{job_id}/results
Download results of an event export job · Get event query job results
#
Ask an LLM
“How do I page through the rows of a finished analytics event export?”
“Can I stream exported website events as newline-delimited JSON?”
Tell an agent
Fetch the exported events from job {job_id}.
Get page {page} of event export {job_id} with {page_size} rows per page.
Ask an LLM
“What standard and custom objects exist in my Unify workspace?”
“Which kinds of records, like company, person or opportunity, can my workspace store?”
Tell an agent
List every object defined in my workspace.
Show me all standard and custom object types.
Ask an LLM
“How do I add a custom object to store a new kind of record?”
“Can I change a custom object's API name after I create it?”
Tell an agent
Create a custom object {api_name} called {display_name} described as {description}, provided by {provider}.
Add a new custom object type named {display_name} with API name {api_name}, provider {provider} and description {description}.
Ask an LLM
“What does the definition of one of my workspace objects look like?”
“Can I look up a single object type by its API name?”
Tell an agent
Show the definition of object {object_name}.
Get the {object_name} object's display name and description.
Ask an LLM
“Can I rename an object's display name without changing its API name?”
“How do I update the description shown for an object in the UI?”
Tell an agent
Rename object {object_name} to {display_name} with description {description}.
Update the {object_name} object's description to {description} and display name to {display_name}.
Ask an LLM
“How do I remove a custom object type I no longer need?”
“Can an entire object be deleted by its API name?”
Tell an agent destructive · confirm first
Delete the object {object_name}.
Remove the custom object type {object_name} from my workspace.
GET
/data/v1/objects/{object_name}/attributes
List the attributes on an object · List object attributes
#
Ask an LLM
“Which fields are defined on my company object?”
“What attributes can records of a given object hold values for?”
Tell an agent
List all attributes on the {object_name} object.
Show me the fields defined for {object_name}.
POST
/data/v1/objects/{object_name}/attributes
Add an attribute to an object · Create object attribute
#
Ask an LLM
“How do I add a new field to an object, like a select or a reference to another object?”
“Can I change an attribute's value type after creating it?”
Tell an agent
Add a new attribute to the {object_name} object.
Create a reference field on {object_name} that links to another object's records.
GET
/data/v1/objects/{object_name}/attributes/{attribute_name}
Get one attribute on an object · Get object attribute
#
Ask an LLM
“How can I see the type and settings of a single field on an object?”
“Is a particular attribute on my object unique or required?”
Tell an agent
Show attribute {attribute_name} on object {object_name}.
Get the definition of the {attribute_name} field of {object_name}.
PATCH
/data/v1/objects/{object_name}/attributes/{attribute_name}
Update an attribute's display name or description · Update object attribute
#
Ask an LLM
“Can I rename a field's display name on an object after it exists?”
“Is it possible to downgrade a reference attribute from many to one?”
Tell an agent
Update the display name and description of attribute {attribute_name} on {object_name}.
Edit the {attribute_name} field settings on object {object_name}.
DELETE
/data/v1/objects/{object_name}/attributes/{attribute_name}
Delete an attribute from an object · Delete object attribute
#
Ask an LLM
“How do I remove a field I no longer use from an object?”
“Can I delete an attribute by its API name?”
Tell an agent destructive · confirm first
Delete attribute {attribute_name} from object {object_name}.
Remove the {attribute_name} field from {object_name}.
GET
/data/v1/objects/{object_name}/attributes/{attribute_name}/options
List the options of a select attribute · List object attribute options
#
Ask an LLM
“What values can I pick from in a select or multi-select field?”
“Which predefined options exist on a dropdown attribute?”
Tell an agent
List the options of select field {attribute_name} on {object_name}.
Show the allowed values for the {attribute_name} dropdown on object {object_name}.
POST
/data/v1/objects/{object_name}/attributes/{attribute_name}/options
Add an option to a select attribute · Create object attribute option
#
Ask an LLM
“How do I add a new choice to a select or multi-select field?”
“Can I give a dropdown option a separate API name and display name?”
Tell an agent
Add option {display_name} with API name {api_name} to the {attribute_name} field on {object_name}.
Create a new choice {api_name} labeled {display_name} on select attribute {attribute_name} of {object_name}.
GET
/data/v1/objects/{object_name}/attributes/{attribute_name}/options/{option_name}
Get one option of a select attribute · Get object attribute option
#
Ask an LLM
“How can I look up a single dropdown option by its API name?”
“What is the display label of a specific select option?”
Tell an agent
Show option {option_name} of field {attribute_name} on {object_name}.
Get the {option_name} choice from select attribute {attribute_name} of object {object_name}.
PATCH
/data/v1/objects/{object_name}/attributes/{attribute_name}/options/{option_name}
Rename an option of a select attribute · Update object attribute option
#
Ask an LLM
“Can I relabel a dropdown option without changing its API name?”
“How do I change the display name of a select field choice?”
Tell an agent
Rename option {option_name} on field {attribute_name} of {object_name} to {display_name}.
Change the label of the {option_name} choice in {object_name}.{attribute_name} to {display_name}.
DELETE
/data/v1/objects/{object_name}/attributes/{attribute_name}/options/{option_name}
Delete an option from a select attribute · Delete object attribute option
#
Ask an LLM
“How do I remove a choice from a select or multi-select field?”
“Can I delete one dropdown value without deleting the whole attribute?”
Tell an agent destructive · confirm first
Delete option {option_name} from field {attribute_name} on {object_name}.
Remove the {option_name} choice from the {attribute_name} dropdown of {object_name}.
POST
/data/v1/objects/{object_name}/query-jobs
Start a bulk export of an object's records · Create object record query job
#
Ask an LLM
“How do I bulk export all person records with only the fields I choose?”
“Can a record export filter on attribute values and sort by last updated for incremental syncs?”
Tell an agent
Start an export of {object_name} records using query {query}.
Kick off a bulk record export job on {object_name} selecting and filtering with {query}.
GET
/data/v1/objects/{object_name}/query-jobs
List record export jobs for an object · List object record query jobs
#
Ask an LLM
“Which record export jobs have I run against my company object?”
“Can I filter an object's record export jobs by status?”
Tell an agent
List record export jobs for object {object_name}.
Show {object_name} record export jobs with status {status}.
GET
/data/v1/objects/{object_name}/query-jobs/{job_id}
Check the status of a record export job · Get object record query job
#
Ask an LLM
“Is my company record export job done yet?”
“How long do object record export jobs stay available?”
Tell an agent
Check the status of {object_name} record export job {job_id}.
Poll record export {job_id} on object {object_name} until it finishes.
POST
/data/v1/objects/{object_name}/query-jobs/{job_id}/cancel
Cancel a running record export job · Cancel object record query job
#
Ask an LLM
“Can I stop a record export on an object that is taking too long?”
“What happens if I try to cancel a record export that already finished?”
Tell an agent destructive · confirm first
Cancel record export job {job_id} on {object_name}.
Stop the in-progress {object_name} record export {job_id}.
GET
/data/v1/objects/{object_name}/query-jobs/{job_id}/results
Download results of a record export job · Get object record query job results
#
Ask an LLM
“How do I page through the records a finished object export returned?”
“Why are some attributes missing from rows in my record export results?”
Tell an agent
Fetch the exported {object_name} records from job {job_id}.
Get page {page} of record export {job_id} on {object_name} with {page_size} rows.
Ask an LLM
“How do I add a brand-new company or person record?”
“What happens if I create a record whose unique field duplicates an existing one?”
Tell an agent
Create a new {object_name} record with values {data}.
Insert a {object_name} record with {data} using validation mode {validation_mode}.
POST
/data/v1/objects/{object_name}/records/find-unique
Find one record by a unique attribute · Find unique object record
#
Ask an LLM
“How can I look up a person record by their email instead of its ID?”
“What comes back when no record matches the unique value I search for?”
Tell an agent
Find the {object_name} record matching {match}.
Look up the single {object_name} whose unique field values are {match}.
POST
/data/v1/objects/{object_name}/records/upsert
Create or update a record by a unique match · Upsert object record
#
Ask an LLM
“How do I sync a company into Unify without knowing whether it already exists?”
“Can I only fill in fields that are empty when the record already exists?”
Tell an agent
Upsert a {object_name} record matched on {match}.
Upsert {object_name} matching {match}, setting {create_or_update} whether it is new or existing.
Ask an LLM
“How do I fetch a single record when I already have its ID?”
“Can I read all attribute values of one specific record?”
Tell an agent
Get {object_name} record {record_id}.
Show me the details of record {record_id} in {object_name}.
PATCH
/data/v1/objects/{object_name}/records/{record_id}
Update fields on a record by its ID · Update object record
#
Ask an LLM
“How do I change a few fields on an existing record without touching the others?”
“Does updating a record by ID clear the attributes I leave out?”
Tell an agent
Update {object_name} record {record_id} with {data}.
Set {data} on record {record_id} of {object_name} using validation mode {validation_mode}.
DELETE
/data/v1/objects/{object_name}/records/{record_id}
Delete a record by its ID · Delete object record
#
Ask an LLM
“How do I permanently remove one company or person record?”
“Can I delete a record if I know its ID?”
Tell an agent destructive · confirm first
Delete {object_name} record {record_id}.
Remove record {record_id} from the {object_name} object.
Documentation
📖
Documentation
https://docs.unifygtm.com/developers/api/data/overview
📖
APIReference
https://docs.unifygtm.com/developers/api/data/overview
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/unify/refs/heads/main/rate-limits/unify-rate-limits.yml
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/unify/refs/heads/main/authentication/unify-authentication.yml
📖
Documentation
https://docs.unifygtm.com/developers/api/sequences/overview
📖
APIReference
https://docs.unifygtm.com/developers/api/sequences/overview