Records APIs
Overview
Record APIs allow developers to programmatically create, retrieve, update, search, archive, unarchive, and manage records across all objects in the platform.
These endpoints operate on Record instances are used for synchronization, automation, data migration, middleware integrations, and other scalable application workflows.
How Object and Contact Records Are Exposed Programmatically
All Records, including Contacts, follow the same underlying Record model and are exposed through consistent REST endpoints:
/api/records/{object_identifier}/{entity_id}Object Records
Object Records are referenced using:
object_identifier: the Object’s API nameentity_id: the Record’s UUID
Object Record responses include:
A Record identifier
The Object type
A structured
fieldsObject containing field valuesAdditional metadata depending on the endpoint
Contact Records
Contacts use the same underlying Record model and endpoints as other Object Records.
The primary difference is identifier behavior: Contacts can be retrieved or matched using email in addition to their UUID. In upsert and lookup operations, email typically functions as the unique identifier, whereas Objects use the Record name.
Aside from this identifier distinction, Contacts follow the same CRUD lifecycle and response structure as other Records.
Field Values and Structure
In Record detail and list responses, field values are returned in a structured fields Object keyed by field ID. Relationship fields are represented as structured Objects rather than flat values.
Response structure varies by endpoint. Some operations return full Record Objects, while others return partial data, paginated lists, or specialized value sets (such as the field-values endpoint).
When field data is included, its consistent structured format allows integrations to perform partial updates, traverse relationships, and implement schema-aware synchronization predictably across Object types.
When to Use These APIs
Use Record APIs when Record operations must be automated, repeatable, and programmatically controlled rather than performed through the UI.
Common use cases include:
Synchronizing data across systems
Creating or updating Records from external events (such as web forms or payments)
Handling lifecycle changes
Running dynamic searches
Implementing upsert logic to prevent duplicates and maintain consistent integration behavior.
API Topics in This Section
The following Record API topics build on the concepts introduced here:
These topics focus on working directly with Record instances, covering the full CRUD lifecycle, lookup behavior, search, and upsert patterns used in scalable integrations.
What’s Next
These APIs provide a complete toolkit for building reliable, scalable integrations around Record data. Check each of them out below:
Last updated
Was this helpful?