Unify Object Record Query Jobs API is one of 11 APIs that Unify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Object Record Query Jobs. 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
5 operations
across 4 paths,
and defines 49 schemas.
It is described by OpenAPI 3.0.0, at version 1.
Requests are made against a single base URL, https://api.unifygtm.com.
The identity and technical contract details declared by the specification.
BulkApiJob
object
Bulk API job representation.
7 properties
7 required
BulkApiJobStatus
string
Status of an asynchronous Bulk API job.
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
BulkApiObjectRecordsQuery
object
Query describing which object records to return and how to shape them.
4 properties
1 required
CancelBulkApiJobNotCancelableResponse
object
Response returned when a Bulk API job is not cancelable.
CancelBulkApiJobSuccessResponse
object
Response returned when canceling a Bulk API job.
2 properties
2 required
CreateBulkApiJobSuccessResponse
object
Response returned when creating a Bulk API query job.
3 properties
3 required
CreateBulkApiObjectRecordsJobObjectNotFoundResponse
object
Response returned when the object being queried cannot be found.
CreateBulkApiObjectRecordsJobRequest
object
Request body for creating an object records Bulk API query job.
1 property
1 required
GetBulkApiJobNotFoundResponse
object
Response returned when a Bulk API job cannot be found.
GetBulkApiJobResultsCanceledResponse
object
Response returned when a Bulk API job was canceled and has no results.
GetBulkApiJobResultsExpiredResponse
object
Response returned when Bulk API job results have expired.
2 properties
2 required
GetBulkApiJobResultsFailedResponse
object
Response returned when a Bulk API job failed and has no results.
GetBulkApiJobResultsNotReadyResponse
object
Response returned when Bulk API job results are not ready yet.
GetBulkApiJobResultsPayloadTooLargeResponse
object
Response returned when a requested Bulk API results page is too large.
2 properties
2 required
GetBulkApiJobSuccessResponse
object
Response returned when fetching a Bulk API job.
ListBulkApiJobsSuccessResponse
object
Response returned when listing Bulk API jobs.
2 properties
2 required
SearchRecordsAttributeWhere
object
Filter records by attribute value. The equals value must match the type of the attribute being filtered.
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
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
SearchRecordsMetadataSortField
string
Base record field to sort by.
SearchRecordsNestedSelect
object
Select the attributes of a referenced record reached through a single-reference 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…
SearchRecordsSortDirection
string
Direction in which to sort records.
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
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…
UObjects.UObjectName
string
The API name of an object, e.g. company, person, opportunity, or a custom object's API name.
UResponses.BadRequestError
object
Validation error detail returned for bad request responses.
4 properties
1 required
UValues.UAddress
object
Composite object representing a physical address.
9 properties
UValues.UBoolean
boolean
Boolean value.
UValues.UCountry
object
Composite object representing a country.
2 properties
2 required
UValues.UCountryCode
string
ISO 3166-1 alpha-2 country code.
UValues.UCurrency
object
Composite object representing a currency value.
2 properties
2 required
UValues.UCurrencyCode
string
ISO 4217 currency code.
UValues.UDate
string
String value representing a date.
UValues.UDatetime
string
String value representing a datetime.
UValues.UDecimal
number
Decimal value.
UValues.UEmail
string
String value representing an email address.
UValues.UInteger
integer
Integer value.
UValues.UMultiSelect
array
String array that contains strings from a specific set of allowed values.
UValues.UPhoneNumber
string
String value representing a phone number.
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
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
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.USelect
string
String value that matches one of a specific set of allowed values.
UValues.UText
string
String value.
UValues.UUrl
string
String value representing a web URL or internet domain.
UValues.UUuid
string
String UUIDv4 value.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Unify publishes across the network.
