# Records APIs

## Overview

<code class="expression">space.vars.entity</code> APIs allow developers to programmatically create, retrieve, update, search, archive, unarchive, and manage records across all objects in the platform.&#x20;

These endpoints operate on <code class="expression">space.vars.entity</code> instances are used for synchronization, automation, data migration, middleware integrations, and other scalable application workflows.&#x20;

### How Object and Contact Records Are Exposed Programmatically

All <code class="expression">space.vars.entities</code>, including <code class="expression">space.vars.contacts</code>, follow the same underlying <code class="expression">space.vars.entity</code> model and are exposed through consistent REST endpoints:

```
/api/records/{object_identifier}/{entity_id}
```

#### Object Records

<code class="expression">space.vars.object</code> <code class="expression">space.vars.entities</code> are referenced using:

* `object_identifier`**:** the <code class="expression">space.vars.object</code>’s API name
* `entity_id`**:** the <code class="expression">space.vars.entity</code>’s UUID

<code class="expression">space.vars.object</code> <code class="expression">space.vars.entity</code> responses include:

* A <code class="expression">space.vars.entity</code> identifier
* The <code class="expression">space.vars.object</code> type
* A structured `fields` <code class="expression">space.vars.object</code> containing field values
* Additional metadata depending on the endpoint

#### Contact Records

<code class="expression">space.vars.contacts</code> use the same underlying <code class="expression">space.vars.entity</code> model and endpoints as other <code class="expression">space.vars.object</code> <code class="expression">space.vars.entities</code>.

The primary difference is identifier behavior: <code class="expression">space.vars.contacts</code> 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 <code class="expression">space.vars.objects</code> use the <code class="expression">space.vars.entity</code> name.

Aside from this identifier distinction, <code class="expression">space.vars.contacts</code> follow the same CRUD lifecycle and response structure as other <code class="expression">space.vars.entities</code>.

#### Field Values and Structure

In <code class="expression">space.vars.entity</code> detail and list responses, field values are returned in a structured `fields` <code class="expression">space.vars.object</code> keyed by field ID. Relationship fields are represented as structured <code class="expression">space.vars.objects</code> rather than flat values.

Response structure varies by endpoint. Some operations return full <code class="expression">space.vars.entity</code> <code class="expression">space.vars.objects</code>, 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 <code class="expression">space.vars.object</code> types.

### When to Use These APIs

Use <code class="expression">space.vars.entity</code> APIs when <code class="expression">space.vars.entity</code> 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 <code class="expression">space.vars.entities</code> 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 <code class="expression">space.vars.entity</code> API topics build on the concepts introduced here:

* [Add Records API](/docs/concepts/objects/records/records-apis/add-records-api.md)
* [Manage Records by ID API](/docs/concepts/objects/records/records-apis/manage-records-by-id-api.md)
* [Lookup Record API](/docs/concepts/objects/records/records-apis/lookup-record-api.md)
* [Search Records API](/docs/concepts/objects/records/records-apis/search-records-api.md)
* [Create or Update Records (Upsert) API](/docs/concepts/objects/records/records-apis/create-or-update-records-upsert-api.md)

These topics focus on working directly with <code class="expression">space.vars.entity</code> 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 <code class="expression">space.vars.entity</code> data. Check each of them out below:

<details>

<summary>Related Topics</summary>

* [Add Records API](/docs/concepts/objects/records/records-apis.md)
* [Manage Records by ID API](/docs/concepts/objects/records/records-apis/manage-records-by-id-api.md)
* [Lookup Record API](/docs/concepts/objects/records/records-apis/lookup-record-api.md)
* [Search Records API](/docs/concepts/objects/records/records-apis/search-records-api.md)
* [Create or Update Records (Upsert) API](/docs/concepts/objects/records/records-apis/create-or-update-records-upsert-api.md)

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.kizen.com/docs/concepts/objects/records/records-apis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.