The identity and technical contract details declared by the specification.
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
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Unify publishes across the network.