@graph8/sdk 0.302.0 → 0.308.1

package/docs/api/objects.md

@@ -2,7 +2,7 @@
 
 # `g8.api.objects`: Objects
 
-18 operations (7 read, 8 write, 3 destructive).
+41 operations (13 read, 22 write, 6 destructive).
 
 18 of these also have a hand-written method (`g8.objects`), marked **★** below. Prefer the hand-written method when one exists: it unwraps the `data` envelope and takes friendlier arguments. See [../sdk-clients.md](../sdk-clients.md).
 
@@ -25,20 +25,43 @@ Exact TypeScript types for every operation on this page, and every schema they u
 | [`archiveAttribute`](#op-archiveattribute) ★ | `DELETE /api/v1/objects/{object_slug}/attributes/{attr_slug}` | destructive | `objects:manage` | Archive Attribute |
 | [`archiveObject`](#op-archiveobject) ★ | `DELETE /api/v1/objects/{object_slug}` | destructive | `objects:manage` | Archive Object |
 | [`archiveObjectRecord`](#op-archiveobjectrecord) ★ | `DELETE /api/v1/objects/{object_slug}/records/{record_id}` | destructive | `objects:delete` | Archive Object Record |
+| [`bulkUpdateObjectRecords`](#op-bulkupdateobjectrecords) | `PATCH /api/v1/objects/{object_slug}/records/bulk` | write | `objects:write` | Bulk Update Object Records |
+| [`commitObjectCsvImport`](#op-commitobjectcsvimport) | `POST /api/v1/objects/{object_slug}/imports/csv/drafts/{draft_id}/commit` | write | `objects:write` | Commit Object Csv Import |
 | [`createAttribute`](#op-createattribute) ★ | `POST /api/v1/objects/{object_slug}/attributes` | write | `objects:manage` | Create Attribute |
 | [`createObject`](#op-createobject) ★ | `POST /api/v1/objects` | write | `objects:manage` | Create Object |
+| [`createObjectCsvImport`](#op-createobjectcsvimport) | `POST /api/v1/objects/{object_slug}/imports/csv/drafts` | write | `objects:write` | Create Object Csv Import |
 | [`createObjectRecord`](#op-createobjectrecord) ★ | `POST /api/v1/objects/{object_slug}/records` | write | `objects:write` | Create Object Record |
+| [`createObjectRelationship`](#op-createobjectrelationship) | `POST /api/v1/objects/{object_slug}/records/{record_id}/relationships` | write | `objects:write` | Create Object Relationship |
+| [`createObjectView`](#op-createobjectview) | `POST /api/v1/objects/{object_slug}/views` | write | `objects:write` | Create Object View |
+| [`deleteObjectCsvImport`](#op-deleteobjectcsvimport) | `DELETE /api/v1/objects/{object_slug}/imports/csv/drafts/{draft_id}` | destructive | `objects:write` | Delete Object Csv Import |
+| [`deleteObjectRelationship`](#op-deleteobjectrelationship) | `DELETE /api/v1/objects/{object_slug}/records/{record_id}/relationships/{relationship_id}` | destructive | `objects:write` | Delete Object Relationship |
+| [`deleteObjectView`](#op-deleteobjectview) | `DELETE /api/v1/objects/{object_slug}/views/{view_id}` | destructive | `objects:delete` | Delete Object View |
+| [`downloadObjectCsvImportErrors`](#op-downloadobjectcsvimporterrors) | `GET /api/v1/objects/{object_slug}/imports/csv/drafts/{draft_id}/errors` | read | `objects:write` | Download Object Csv Import Errors |
+| [`exportObjectRecords`](#op-exportobjectrecords) | `POST /api/v1/objects/{object_slug}/exports` | write | `objects:export` | Export Object Records |
 | [`getObject`](#op-getobject) ★ | `GET /api/v1/objects/{object_slug}` | read | `objects:read` | Get Object |
+| [`getObjectCsvImport`](#op-getobjectcsvimport) | `GET /api/v1/objects/{object_slug}/imports/csv/drafts/{draft_id}` | read | `objects:write` | Get Object Csv Import |
 | [`getObjectRecord`](#op-getobjectrecord) ★ | `GET /api/v1/objects/{object_slug}/records/{record_id}` | read | `objects:read` | Get Object Record |
 | [`getObjectRecordChanges`](#op-getobjectrecordchanges) ★ | `GET /api/v1/objects/{object_slug}/records/{record_id}/changes` | read | `objects:read` | Get Object Record Changes |
 | [`getObjectRecordHistory`](#op-getobjectrecordhistory) ★ | `GET /api/v1/objects/{object_slug}/records/{record_id}/history` | read | `objects:read` | Get Object Record History |
+| [`getObjectRelationshipDefinitions`](#op-getobjectrelationshipdefinitions) | `GET /api/v1/objects/{object_slug}/relationships` | read | `objects:read` | Get Object Relationship Definitions |
+| [`getObjectRelationships`](#op-getobjectrelationships) | `GET /api/v1/objects/{object_slug}/records/{record_id}/relationships` | read | `objects:read` | Get Object Relationships |
+| [`inspectObjectCsvImport`](#op-inspectobjectcsvimport) | `POST /api/v1/objects/{object_slug}/imports/csv/inspect` | write | `objects:write` | Inspect Object Csv Import |
 | [`listObjectAttributes`](#op-listobjectattributes) ★ | `GET /api/v1/objects/{object_slug}/attributes` | read | `objects:read` | List Object Attributes |
+| [`listObjectCsvImports`](#op-listobjectcsvimports) | `GET /api/v1/objects/{object_slug}/imports/csv/drafts` | read | `objects:write` | List Object Csv Imports |
 | [`listObjectRecords`](#op-listobjectrecords) ★ | `GET /api/v1/objects/{object_slug}/records` | read | `objects:read` | List Object Records |
+| [`listObjectViews`](#op-listobjectviews) | `GET /api/v1/objects/{object_slug}/views` | read | `objects:read` | List Object Views |
 | [`listObjects`](#op-listobjects) ★ | `GET /api/v1/objects` | read | `objects:read` | List Objects |
+| [`mergeObjectRecords`](#op-mergeobjectrecords) | `POST /api/v1/objects/{object_slug}/records/merge` | write | `objects:write` | Merge Object Records |
+| [`previewObjectCsvImport`](#op-previewobjectcsvimport) | `POST /api/v1/objects/{object_slug}/imports/csv/drafts/{draft_id}/preview` | write | `objects:write` | Preview Object Csv Import |
+| [`queryObjectBoardGroups`](#op-queryobjectboardgroups) | `POST /api/v1/objects/{object_slug}/views/board/groups` | write | `objects:read` | Query Object Board Groups |
+| [`queryObjectBoardRecords`](#op-queryobjectboardrecords) | `POST /api/v1/objects/{object_slug}/views/board/records` | write | `objects:read` | Query Object Board Records |
 | [`restoreObjectRecord`](#op-restoreobjectrecord) ★ | `POST /api/v1/objects/{object_slug}/records/{record_id}/restore` | write | `objects:write` | Restore Object Record |
+| [`setDefaultObjectView`](#op-setdefaultobjectview) | `PUT /api/v1/objects/{object_slug}/views/default` | write | `objects:write` | Set Default Object View |
 | [`updateAttribute`](#op-updateattribute) ★ | `PATCH /api/v1/objects/{object_slug}/attributes/{attr_slug}` | write | `objects:manage` | Update Attribute |
 | [`updateObject`](#op-updateobject) ★ | `PATCH /api/v1/objects/{object_slug}` | write | `objects:manage` | Update Object |
+| [`updateObjectCsvImport`](#op-updateobjectcsvimport) | `PUT /api/v1/objects/{object_slug}/imports/csv/drafts/{draft_id}` | write | `objects:write` | Update Object Csv Import |
 | [`updateObjectRecord`](#op-updateobjectrecord) ★ | `PATCH /api/v1/objects/{object_slug}/records/{record_id}` | write | `objects:write` | Update Object Record |
+| [`updateObjectView`](#op-updateobjectview) | `PUT /api/v1/objects/{object_slug}/views/{view_id}` | write | `objects:write` | Update Object View |
 | [`upsertObjectRecord`](#op-upsertobjectrecord) ★ | `POST /api/v1/objects/{object_slug}/records/upsert` | write | `objects:write` | Upsert Object Record |
 
 ---
@@ -85,6 +108,7 @@ Other envelope fields: `pagination` (PaginationMeta).
 | `is_system` | `boolean` | no | Whether this field is protected as a system attribute. default `false` |
 | `is_unique` | `boolean` | no | No two active records may hold the same value for this attribute. A collision is rejected with `409 duplicate_active_value`. default `false` |
 | `sort_order` | `integer` | no | Configured display order; equal values are ordered by API slug. default `0` |
+| `visible_to_role_ids` | `Array<string> \| null` | no | Role ids that may see this field; null means every role. Owners and admins always see every field. A field hidden from the caller is absent from every response. Set it with PATCH on this attribute. |
 
 **Example**
 
@@ -196,6 +220,137 @@ const result = await g8.api.objects.archiveObjectRecord({ path: { object_slug: "
 
 ---
 
+<a id="op-bulkupdateobjectrecords"></a>
+
+### `g8.api.objects.bulkUpdateObjectRecords(input)`
+
+**Bulk Update Object Records**
+
+- HTTP: `PATCH /api/v1/objects/{object_slug}/records/bulk`
+- operationId: `bulk_update_object_records_objects__object_slug__records_bulk_patch` (also callable as `g8.api.call("bulk_update_object_records_objects__object_slug__records_bulk_patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `objects:write`
+
+Apply the same values to every record in an explicit or filtered scope.
+
+Registered before ``/{object_slug}/records/{record_id}``: routes match by
+path shape, so "bulk" would otherwise bind to ``{record_id}``. Needs
+objects:read as well as objects:write (a filtered scope echoes the ids that
+match caller-chosen predicates). Delegates to the Studio function, so the
+server-side filter resolution, the 500-row cursor, the per-row savepoints
+and the per-org ``records_core`` switch (404 while off) are identical.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `body` | `RecordBulkUpdate` | yes | Request body; fields below. |
+
+Body fields (`RecordBulkUpdate`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.after_record_id` | `string (uuid) \| null` | no |  |
+| `body.filters` | `Array<RecordFilter> \| null` | no | max items 10 |
+| `body.record_ids` | `Array<string (uuid)> \| null` | no | max items 500 |
+| `body.values` | `Record<string, unknown>` | no |  |
+
+**Returns** `ApiResponse_RecordBulkUpdateResponse_`: the envelope `{ data: RecordBulkUpdateResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`RecordBulkUpdateResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `failed` | `Array<RecordBulkUpdateFailure>` | yes |  |
+| `succeeded` | `Array<string (uuid)>` | yes |  |
+| `next_after_record_id` | `string (uuid) \| null` | no |  |
+| `truncated` | `boolean` | no | default `false` |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.bulkUpdateObjectRecords({ path: { object_slug: "example" }, body: {} });
+```
+
+---
+
+<a id="op-commitobjectcsvimport"></a>
+
+### `g8.api.objects.commitObjectCsvImport(input)`
+
+**Commit Object Csv Import**
+
+- HTTP: `POST /api/v1/objects/{object_slug}/imports/csv/drafts/{draft_id}/commit`
+- operationId: `commit_object_csv_import_objects__object_slug__imports_csv_drafts__draft_id__commit_post` (also callable as `g8.api.call("commit_object_csv_import_objects__object_slug__imports_csv_drafts__draft_id__commit_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `objects:write`
+
+Commit one previewed page (at most 100 rows) in one transaction. Valid rows are imported; rows that do not validate
+are skipped and listed in skipped_rows (download them from .../errors). Send the page's revision, offset, limit,
+schema_fingerprint and every row's row_number, record_id and revision from the preview. created, updated and skipped
+count this request; resending a committed page replays its receipts as already_imported and counts nothing twice. A
+409 is never fixed by resending the same body: preview the page again.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.draft_id` | `string (uuid)` | yes |  |
+| `body` | `ObjectImportCommit` | yes | Request body; fields below. |
+
+Body fields (`ObjectImportCommit`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.expected` | `Array<ImportRowExpectation>` | yes | min items 1, max items 100 |
+| `body.revision` | `integer` | yes | The draft revision this page was planned against min 1 |
+| `body.schema_fingerprint` | `string` | yes | pattern `^[a-f0-9]{64}$` |
+| `body.limit` | `integer` | no | default `100`, min 1, max 100 |
+| `body.offset` | `integer` | no | default `0`, min 0, max 4999 |
+
+**Returns** `ApiResponse_ObjectCsvReceipt_`: the envelope `{ data: ObjectCsvReceipt, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectCsvReceipt` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `already_imported` | `integer` | yes |  |
+| `completed` | `integer` | yes |  |
+| `created` | `integer` | yes |  |
+| `error_file_available` | `boolean` | yes |  |
+| `error_rows` | `integer` | yes |  |
+| `rows` | `Array<ImportReceiptRow>` | yes |  |
+| `skipped` | `integer` | yes |  |
+| `status` | `"draft" \| "partial" \| "completed" \| "expired"` | yes |  |
+| `total` | `integer` | yes |  |
+| `updated` | `integer` | yes |  |
+| `replayed` | `boolean` | no | default `false` |
+| `skipped_rows` | `Array<ImportSkippedRow>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.commitObjectCsvImport({
+  path: {
+    object_slug: "example",
+    draft_id: "00000000-0000-0000-0000-000000000000",
+  },
+  body: {
+    expected: [{ row_number: 2 }],
+    revision: 1,
+    schema_fingerprint: "example",
+  },
+});
+```
+
+---
+
 <a id="op-createattribute"></a>
 
 ### `g8.api.objects.createAttribute(input)`
@@ -257,6 +412,7 @@ Other envelope fields: `pagination` (PaginationMeta).
 | `is_system` | `boolean` | no | Whether this field is protected as a system attribute. default `false` |
 | `is_unique` | `boolean` | no | No two active records may hold the same value for this attribute. A collision is rejected with `409 duplicate_active_value`. default `false` |
 | `sort_order` | `integer` | no | Configured display order; equal values are ordered by API slug. default `0` |
+| `visible_to_role_ids` | `Array<string> \| null` | no | Role ids that may see this field; null means every role. Owners and admins always see every field. A field hidden from the caller is absent from every response. Set it with PATCH on this attribute. |
 
 **Example**
 
@@ -329,6 +485,73 @@ const result = await g8.api.objects.createObject({
 
 ---
 
+<a id="op-createobjectcsvimport"></a>
+
+### `g8.api.objects.createObjectCsvImport(input)`
+
+**Create Object Csv Import**
+
+- HTTP: `POST /api/v1/objects/{object_slug}/imports/csv/drafts`
+- operationId: `create_object_csv_import_objects__object_slug__imports_csv_drafts_post` (also callable as `g8.api.call("create_object_csv_import_objects__object_slug__imports_csv_drafts_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `objects:write`
+
+Upload a CSV once with its column mapping (header to field slug), mode create or upsert, and matching field for upsert.
+The file is stored with the import for 30 days or until every row is imported. Writes no records.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `body` | `ObjectImportCreate` | yes | Request body; fields below. |
+
+Body fields (`ObjectImportCreate`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.csv` | `string` | yes | min length 1, max length 2000000 |
+| `body.filename` | `string` | yes | min length 1, max length 255 |
+| `body.mapping` | `Record<string, string>` | no |  |
+| `body.matching_attribute` | `string \| null` | no | max length 100 |
+| `body.mode` | `"create" \| "upsert"` | no | default `"create"` |
+
+**Returns** `ApiResponse_ObjectImportDetail_`: the envelope `{ data: ObjectImportDetail, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectImportDetail` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `completed` | `integer` | yes |  |
+| `created_at` | `string (date-time)` | yes |  |
+| `error_rows` | `integer` | yes |  |
+| `expires_at` | `string (date-time)` | yes |  |
+| `filename` | `string` | yes |  |
+| `headers` | `Array<string>` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `owner_id` | `string` | yes |  |
+| `owner_type` | `"user" \| "api"` | yes |  |
+| `revision` | `integer` | yes |  |
+| `setup` | `ObjectImportSetup` | yes |  |
+| `source_available` | `boolean` | yes |  |
+| `status` | `"draft" \| "partial" \| "completed" \| "expired"` | yes |  |
+| `total` | `integer` | yes |  |
+| `updated_at` | `string (date-time)` | yes |  |
+| `sample` | `Array<Array<string>>` | no | First rows of the file while it is still stored |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.createObjectCsvImport({
+  path: { object_slug: "example" },
+  body: { csv: "example", filename: "Example" },
+});
+```
+
+---
+
 <a id="op-createobjectrecord"></a>
 
 ### `g8.api.objects.createObjectRecord(input)`
@@ -388,126 +611,183 @@ const result = await g8.api.objects.createObjectRecord({ path: { object_slug: "e
 
 ---
 
-<a id="op-getobject"></a>
-
-### `g8.api.objects.getObject(input)`
+<a id="op-createobjectrelationship"></a>
 
-**Get Object**
+### `g8.api.objects.createObjectRelationship(input)`
 
-- HTTP: `GET /api/v1/objects/{object_slug}`
-- operationId: `get_object_objects__object_slug__get` (also callable as `g8.api.call("get_object_objects__object_slug__get", input)`)
-- Tier: `read`: reads data; safe to call and to retry
-- API-key scope: `objects:read`
-- Lifecycle: `preview` (may not be enabled for every org yet)
-- ★ Hand-written: [`g8.objects.get()`](../sdk-clients.md#g8-objects-get)
+**Create Object Relationship**
 
-PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+- HTTP: `POST /api/v1/objects/{object_slug}/records/{record_id}/relationships`
+- operationId: `create_object_relationship_objects__object_slug__records__record_id__relationships_post` (also callable as `g8.api.call("create_object_relationship_objects__object_slug__records__record_id__relationships_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `objects:write`
 
-Fetch one accessible registered standard or custom object type by its slug.
+Link from a custom or canonical native record. The request's expected revisions are
+relative to the route's record; the response is always in the definition's canonical
+direction (source = the custom record, target = the native or custom target).
 
 **Input**
 
 | Field | Type | Required | Description |
 |---|---|---|---|
 | `path.object_slug` | `string` | yes |  |
+| `path.record_id` | `string` | yes |  |
+| `body` | `RelationshipCreate` | yes | Request body; fields below. |
 
-**Returns** `ApiResponse_ObjectDefinitionResponse_`: the envelope `{ data: ObjectDefinitionResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+Body fields (`RelationshipCreate`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.definition_id` | `string (uuid)` | yes |  |
+| `body.expected_definition_revision` | `integer` | yes | > 0 |
+| `body.expected_source_revision` | `integer` | yes | > 0 |
+| `body.expected_target_revision` | `integer` | yes | > 0 |
+| `body.target_record_id` | `string` | yes | min length 1, max length 255 |
+
+**Returns** `ApiResponse_RelationshipResponse_`: the envelope `{ data: RelationshipResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
 
 Other envelope fields: `pagination` (PaginationMeta).
 
-`ObjectDefinitionResponse` fields:
+`RelationshipResponse` fields:
 
 | Field | Type | Required | Description |
 |---|---|---|---|
-| `plural_noun` | `string` | yes | Display name for many records, e.g. "Invoices". |
-| `singular_noun` | `string` | yes | Display name for one record, e.g. "Invoice". |
-| `slug` | `string` | yes | Stable API slug for the object type, e.g. `invoices`. |
-| `description` | `string \| null` | no | Customer-configured object description. |
-| `display_attribute_slug` | `string \| null` | no | Active single-value field used to label records; null uses the default. |
-| `icon` | `string \| null` | no | Configured graph8 icon name; null uses the default. |
-| `is_archived` | `boolean` | no | Archived objects are hidden from listings. default `false` |
-| `is_system` | `boolean` | no | True for objects graph8 ships; system objects cannot be deleted. default `false` |
+| `definition_id` | `string (uuid)` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `source_kind` | `string` | yes |  |
+| `source_record_id` | `string` | yes |  |
+| `source_revision` | `integer` | yes |  |
+| `target_kind` | `string` | yes |  |
+| `target_record_id` | `string` | yes |  |
+| `target_revision` | `integer` | yes |  |
 
 **Example**
 
 ```ts
-const result = await g8.api.objects.getObject({ path: { object_slug: "example" } });
+const result = await g8.api.objects.createObjectRelationship({
+  path: { object_slug: "example", record_id: "id" },
+  body: {
+    definition_id: "00000000-0000-0000-0000-000000000000",
+    expected_definition_revision: 1,
+    expected_source_revision: 1,
+    expected_target_revision: 1,
+    target_record_id: "id",
+  },
+});
 ```
 
 ---
 
-<a id="op-getobjectrecord"></a>
-
-### `g8.api.objects.getObjectRecord(input)`
-
-**Get Object Record**
+<a id="op-createobjectview"></a>
 
-- HTTP: `GET /api/v1/objects/{object_slug}/records/{record_id}`
-- operationId: `get_object_record_objects__object_slug__records__record_id__get` (also callable as `g8.api.call("get_object_record_objects__object_slug__records__record_id__get", input)`)
-- Tier: `read`: reads data; safe to call and to retry
-- API-key scope: `objects:read`
-- Lifecycle: `preview` (may not be enabled for every org yet)
-- ★ Hand-written: [`g8.objects.getRecord()`](../sdk-clients.md#g8-objects-getrecord)
+### `g8.api.objects.createObjectView(input)`
 
-PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+**Create Object View**
 
-Fetch one record with its currently active values.
+- HTTP: `POST /api/v1/objects/{object_slug}/views`
+- operationId: `create_object_view_objects__object_slug__views_post` (also callable as `g8.api.call("create_object_view_objects__object_slug__views_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `objects:write`
 
-Contacts and companies retain their canonical graph8 IDs; deals retain their
-canonical UUIDs. Deal values include active typed fields and permitted
-company, primary-contact and contact_ids references. Related-record access is checked
-independently of deal access. Generic deal mutations are not yet supported.
+Save a private or shared view owned by this credential, without impersonating a human.
 
 **Input**
 
 | Field | Type | Required | Description |
 |---|---|---|---|
 | `path.object_slug` | `string` | yes |  |
-| `path.record_id` | `string` | yes |  |
+| `body` | `ObjectViewCreate` | yes | Request body; fields below. |
 
-**Returns** `ApiResponse_ObjectRecordResponse_`: the envelope `{ data: ObjectRecordResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+Body fields (`ObjectViewCreate`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.title` | `string` | yes | min length 1, max length 120 |
+| `body.state` | `ObjectViewState` | no |  |
+| `body.visibility` | `Visibility` | no | default `"private"` |
+
+**Returns** `ApiResponse_SavedViewResponse_`: the envelope `{ data: SavedViewResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
 
 Other envelope fields: `pagination` (PaginationMeta).
 
-`ObjectRecordResponse` fields:
+`SavedViewResponse` fields:
 
 | Field | Type | Required | Description |
 |---|---|---|---|
-| `id` | `string` | yes | Opaque record identifier. |
-| `object_slug` | `string` | yes | The object type this record belongs to. |
-| `created_at` | `string (date-time) \| null` | no |  |
-| `is_archived` | `boolean` | no | Archived records are excluded from listings. default `false` |
-| `revision` | `integer` | no | Record revision for conditional updates. default `1`, min 1 |
-| `updated_at` | `string (date-time) \| null` | no |  |
-| `values` | `Record<string, unknown>` | no | Currently active values, keyed by attribute slug. Shapes follow each attribute's own type; call `GET /objects/{object_slug}/attributes` for the schema. |
+| `context_key` | `string \| null` | yes |  |
+| `created_at` | `string (date-time) \| null` | yes |  |
+| `created_by` | `string` | yes |  |
+| `description` | `string \| null` | yes |  |
+| `entity_type` | `EntityType` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `is_default` | `boolean` | yes |  |
+| `is_owner` | `boolean` | yes |  |
+| `is_reusable` | `boolean` | yes |  |
+| `state` | `Record<string, unknown>` | yes |  |
+| `title` | `string` | yes |  |
+| `updated_at` | `string (date-time) \| null` | yes |  |
+| `visibility` | `Visibility` | yes |  |
 
 **Example**
 
 ```ts
-const result = await g8.api.objects.getObjectRecord({ path: { object_slug: "example", record_id: "id" } });
+const result = await g8.api.objects.createObjectView({ path: { object_slug: "example" }, body: { title: "Example" } });
 ```
 
 ---
 
-<a id="op-getobjectrecordchanges"></a>
+<a id="op-deleteobjectcsvimport"></a>
 
-### `g8.api.objects.getObjectRecordChanges(input)`
+### `g8.api.objects.deleteObjectCsvImport(input)`
 
-**Get Object Record Changes**
+**Delete Object Csv Import**
 
-- HTTP: `GET /api/v1/objects/{object_slug}/records/{record_id}/changes`
-- operationId: `get_object_record_changes_objects__object_slug__records__record_id__changes_get` (also callable as `g8.api.call("get_object_record_changes_objects__object_slug__records__record_id__changes_get", input)`)
-- Tier: `read`: reads data; safe to call and to retry
-- API-key scope: `objects:read`
-- ★ Hand-written: [`g8.objects.changes()`](../sdk-clients.md#g8-objects-changes)
+- HTTP: `DELETE /api/v1/objects/{object_slug}/imports/csv/drafts/{draft_id}`
+- operationId: `delete_object_csv_import_objects__object_slug__imports_csv_drafts__draft_id__delete` (also callable as `g8.api.call("delete_object_csv_import_objects__object_slug__imports_csv_drafts__draft_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `objects:write`
 
-Read recorded mutation authorship and before/after changes with stable cursor pagination.
+Delete the stored file and setup. Records already imported, their history and import receipts are kept.
 
-Custom records include clear and lifecycle actions. Canonical contacts and companies use
-their existing IDs and audit facts, bounded by current record access and
-field privacy; archived records are unavailable through this reader.
-Older writes without recorded mutation facts are not reconstructed here.
-An unavailable audit store returns 503, never an empty success response.
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.draft_id` | `string (uuid)` | yes |  |
+| `query.revision` | `integer` | yes |  |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.objects.deleteObjectCsvImport({
+  path: {
+    object_slug: "example",
+    draft_id: "00000000-0000-0000-0000-000000000000",
+  },
+  query: { revision: 1 },
+});
+```
+
+---
+
+<a id="op-deleteobjectrelationship"></a>
+
+### `g8.api.objects.deleteObjectRelationship(input)`
+
+**Delete Object Relationship**
+
+- HTTP: `DELETE /api/v1/objects/{object_slug}/records/{record_id}/relationships/{relationship_id}`
+- operationId: `delete_object_relationship_objects__object_slug__records__record_id__relationships__relationship_id__delete` (also callable as `g8.api.call("delete_object_relationship_objects__object_slug__records__record_id__relationships__relationship_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `objects:write`
+
+Unlink only the edge; both records stay. All three revisions are required.
 
 **Input**
 
@@ -515,228 +795,1030 @@ An unavailable audit store returns 503, never an empty success response.
 |---|---|---|---|
 | `path.object_slug` | `string` | yes |  |
 | `path.record_id` | `string` | yes |  |
-| `query.limit` | `integer` | no | default `100` |
-| `query.cursor` | `string \| null` | no |  |
+| `path.relationship_id` | `string (uuid)` | yes |  |
+| `body` | `RelationshipCreate` | yes | Request body; fields below. |
 
-**Returns** `ApiResponse_RecordMutationsResponse_`: the envelope `{ data: RecordMutationsResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+Body fields (`RelationshipCreate`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.definition_id` | `string (uuid)` | yes |  |
+| `body.expected_definition_revision` | `integer` | yes | > 0 |
+| `body.expected_source_revision` | `integer` | yes | > 0 |
+| `body.expected_target_revision` | `integer` | yes | > 0 |
+| `body.target_record_id` | `string` | yes | min length 1, max length 255 |
+
+**Returns** `ApiResponse_RelationshipResponse_`: the envelope `{ data: RelationshipResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
 
 Other envelope fields: `pagination` (PaginationMeta).
 
-`RecordMutationsResponse` fields:
+`RelationshipResponse` fields:
 
 | Field | Type | Required | Description |
 |---|---|---|---|
-| `entries` | `Array<RecordMutationEntry>` | yes |  |
-| `record_id` | `string` | yes |  |
-| `next_cursor` | `string \| null` | no |  |
+| `definition_id` | `string (uuid)` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `source_kind` | `string` | yes |  |
+| `source_record_id` | `string` | yes |  |
+| `source_revision` | `integer` | yes |  |
+| `target_kind` | `string` | yes |  |
+| `target_record_id` | `string` | yes |  |
+| `target_revision` | `integer` | yes |  |
 
 **Example**
 
 ```ts
-const result = await g8.api.objects.getObjectRecordChanges({ path: { object_slug: "example", record_id: "id" } });
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.objects.deleteObjectRelationship({
+  path: {
+    object_slug: "example",
+    record_id: "id",
+    relationship_id: "00000000-0000-0000-0000-000000000000",
+  },
+  body: {
+    definition_id: "00000000-0000-0000-0000-000000000000",
+    expected_definition_revision: 1,
+    expected_source_revision: 1,
+    expected_target_revision: 1,
+    target_record_id: "id",
+  },
+});
 ```
 
 ---
 
-<a id="op-getobjectrecordhistory"></a>
-
-### `g8.api.objects.getObjectRecordHistory(input)`
-
-**Get Object Record History**
+<a id="op-deleteobjectview"></a>
 
-- HTTP: `GET /api/v1/objects/{object_slug}/records/{record_id}/history`
-- operationId: `get_object_record_history_objects__object_slug__records__record_id__history_get` (also callable as `g8.api.call("get_object_record_history_objects__object_slug__records__record_id__history_get", input)`)
-- Tier: `read`: reads data; safe to call and to retry
-- API-key scope: `objects:read`
-- Lifecycle: `preview` (may not be enabled for every org yet)
-- ★ Hand-written: [`g8.objects.history()`](../sdk-clients.md#g8-objects-history)
+### `g8.api.objects.deleteObjectView(input)`
 
-PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+**Delete Object View**
 
-A record's value timeline, newest first.
+- HTTP: `DELETE /api/v1/objects/{object_slug}/views/{view_id}`
+- operationId: `delete_object_view_objects__object_slug__views__view_id__delete` (also callable as `g8.api.call("delete_object_view_objects__object_slug__views__view_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `objects:delete`
 
-Each entry is one generation of one attribute. An entry whose `active_until`
-is null is the value currently in force.
+Delete a view owned by this credential. Does not delete records.
 
 **Input**
 
 | Field | Type | Required | Description |
 |---|---|---|---|
 | `path.object_slug` | `string` | yes |  |
-| `path.record_id` | `string` | yes |  |
-| `query.limit` | `integer` | no | Maximum generations to return default `100` |
+| `path.view_id` | `string (uuid)` | yes |  |
 
-**Returns** `ApiResponse_RecordHistoryResponse_`: the envelope `{ data: RecordHistoryResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+**Returns** `ApiResponse_NoneType_`: the envelope `{ data: null, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
 
 Other envelope fields: `pagination` (PaginationMeta).
 
-`RecordHistoryResponse` fields:
-
-| Field | Type | Required | Description |
-|---|---|---|---|
-| `record_id` | `string` | yes |  |
-| `entries` | `Array<RecordHistoryEntry>` | no |  |
-
 **Example**
 
 ```ts
-const result = await g8.api.objects.getObjectRecordHistory({ path: { object_slug: "example", record_id: "id" } });
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.objects.deleteObjectView({
+  path: {
+    object_slug: "example",
+    view_id: "00000000-0000-0000-0000-000000000000",
+  },
+});
 ```
 
 ---
 
-<a id="op-listobjectattributes"></a>
+<a id="op-downloadobjectcsvimporterrors"></a>
 
-### `g8.api.objects.listObjectAttributes(input)`
+### `g8.api.objects.downloadObjectCsvImportErrors(input)`
 
-**List Object Attributes**
+**Download Object Csv Import Errors**
 
-- HTTP: `GET /api/v1/objects/{object_slug}/attributes`
-- operationId: `list_object_attributes_objects__object_slug__attributes_get` (also callable as `g8.api.call("list_object_attributes_objects__object_slug__attributes_get", input)`)
+- HTTP: `GET /api/v1/objects/{object_slug}/imports/csv/drafts/{draft_id}/errors`
+- operationId: `download_object_csv_import_errors_objects__object_slug__imports_csv_drafts__draft_id__errors_get` (also callable as `g8.api.call("download_object_csv_import_errors_objects__object_slug__imports_csv_drafts__draft_id__errors_get", input)`)
 - Tier: `read`: reads data; safe to call and to retry
-- API-key scope: `objects:read`
-- Lifecycle: `preview` (may not be enabled for every org yet)
-- ★ Hand-written: [`g8.objects.listAttributes()`](../sdk-clients.md#g8-objects-listattributes)
+- API-key scope: `objects:write`
+
+Download skipped and rejected rows as CSV. While the file is stored: the original columns plus row_number, column
+and error, ready to fix and re-upload (cells are spreadsheet-safe). Afterwards: row_number, column and code only,
+never values. Needs the same read grant as an export.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.draft_id` | `string (uuid)` | yes |  |
+
+**Returns** `unknown`.
+
+**Example**
+
+```ts
+const result = await g8.api.objects.downloadObjectCsvImportErrors({
+  path: {
+    object_slug: "example",
+    draft_id: "00000000-0000-0000-0000-000000000000",
+  },
+});
+```
+
+---
+
+<a id="op-exportobjectrecords"></a>
+
+### `g8.api.objects.exportObjectRecords(input)`
+
+**Export Object Records**
+
+- HTTP: `POST /api/v1/objects/{object_slug}/exports`
+- operationId: `export_object_records_objects__object_slug__exports_post` (also callable as `g8.api.call("export_object_records_objects__object_slug__exports_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `objects:export`
+
+Download every matching native custom record of a view (filters, search, sort, columns, archived scope) as CSV or
+typed JSON. Explicit objects:read and objects:export scopes and the key's read grant are required and rechecked before
+delivery. Maximum 256 MB and 120 seconds; no partial files. CSV is spreadsheet-safe. Not a workspace backup.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `body` | `ObjectExportRequest` | yes | Request body; fields below. |
+
+Body fields (`ObjectExportRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.format` | `"csv" \| "json"` | no | default `"csv"` |
+| `body.state` | `ObjectViewState` | no |  |
+
+**Returns** `string (binary)`.
+
+**Example**
+
+```ts
+const result = await g8.api.objects.exportObjectRecords({ path: { object_slug: "example" }, body: {} });
+```
+
+---
+
+<a id="op-getobject"></a>
+
+### `g8.api.objects.getObject(input)`
+
+**Get Object**
+
+- HTTP: `GET /api/v1/objects/{object_slug}`
+- operationId: `get_object_objects__object_slug__get` (also callable as `g8.api.call("get_object_objects__object_slug__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `objects:read`
+- Lifecycle: `preview` (may not be enabled for every org yet)
+- ★ Hand-written: [`g8.objects.get()`](../sdk-clients.md#g8-objects-get)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+Fetch one accessible registered standard or custom object type by its slug.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+
+**Returns** `ApiResponse_ObjectDefinitionResponse_`: the envelope `{ data: ObjectDefinitionResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectDefinitionResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `plural_noun` | `string` | yes | Display name for many records, e.g. "Invoices". |
+| `singular_noun` | `string` | yes | Display name for one record, e.g. "Invoice". |
+| `slug` | `string` | yes | Stable API slug for the object type, e.g. `invoices`. |
+| `description` | `string \| null` | no | Customer-configured object description. |
+| `display_attribute_slug` | `string \| null` | no | Active single-value field used to label records; null uses the default. |
+| `icon` | `string \| null` | no | Configured graph8 icon name; null uses the default. |
+| `is_archived` | `boolean` | no | Archived objects are hidden from listings. default `false` |
+| `is_system` | `boolean` | no | True for objects graph8 ships; system objects cannot be deleted. default `false` |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.getObject({ path: { object_slug: "example" } });
+```
+
+---
+
+<a id="op-getobjectcsvimport"></a>
+
+### `g8.api.objects.getObjectCsvImport(input)`
+
+**Get Object Csv Import**
+
+- HTTP: `GET /api/v1/objects/{object_slug}/imports/csv/drafts/{draft_id}`
+- operationId: `get_object_csv_import_objects__object_slug__imports_csv_drafts__draft_id__get` (also callable as `g8.api.call("get_object_csv_import_objects__object_slug__imports_csv_drafts__draft_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `objects:write`
+
+Read one of this credential's imports: setup, headers, progress, status and up to five sample rows while the file is stored.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.draft_id` | `string (uuid)` | yes |  |
+
+**Returns** `ApiResponse_ObjectImportDetail_`: the envelope `{ data: ObjectImportDetail, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectImportDetail` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `completed` | `integer` | yes |  |
+| `created_at` | `string (date-time)` | yes |  |
+| `error_rows` | `integer` | yes |  |
+| `expires_at` | `string (date-time)` | yes |  |
+| `filename` | `string` | yes |  |
+| `headers` | `Array<string>` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `owner_id` | `string` | yes |  |
+| `owner_type` | `"user" \| "api"` | yes |  |
+| `revision` | `integer` | yes |  |
+| `setup` | `ObjectImportSetup` | yes |  |
+| `source_available` | `boolean` | yes |  |
+| `status` | `"draft" \| "partial" \| "completed" \| "expired"` | yes |  |
+| `total` | `integer` | yes |  |
+| `updated_at` | `string (date-time)` | yes |  |
+| `sample` | `Array<Array<string>>` | no | First rows of the file while it is still stored |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.getObjectCsvImport({
+  path: {
+    object_slug: "example",
+    draft_id: "00000000-0000-0000-0000-000000000000",
+  },
+});
+```
+
+---
+
+<a id="op-getobjectrecord"></a>
+
+### `g8.api.objects.getObjectRecord(input)`
+
+**Get Object Record**
+
+- HTTP: `GET /api/v1/objects/{object_slug}/records/{record_id}`
+- operationId: `get_object_record_objects__object_slug__records__record_id__get` (also callable as `g8.api.call("get_object_record_objects__object_slug__records__record_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `objects:read`
+- Lifecycle: `preview` (may not be enabled for every org yet)
+- ★ Hand-written: [`g8.objects.getRecord()`](../sdk-clients.md#g8-objects-getrecord)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+Fetch one record with its currently active values.
+
+Contacts and companies retain their canonical graph8 IDs; deals retain their
+canonical UUIDs. Deal values include active typed fields and permitted
+company, primary-contact and contact_ids references. Related-record access is checked
+independently of deal access. Generic deal mutations are not yet supported.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.record_id` | `string` | yes |  |
+
+**Returns** `ApiResponse_ObjectRecordResponse_`: the envelope `{ data: ObjectRecordResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectRecordResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes | Opaque record identifier. |
+| `object_slug` | `string` | yes | The object type this record belongs to. |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `is_archived` | `boolean` | no | Archived records are excluded from listings. default `false` |
+| `revision` | `integer` | no | Record revision for conditional updates. default `1`, min 1 |
+| `updated_at` | `string (date-time) \| null` | no |  |
+| `values` | `Record<string, unknown>` | no | Currently active values, keyed by attribute slug. Shapes follow each attribute's own type; call `GET /objects/{object_slug}/attributes` for the schema. |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.getObjectRecord({ path: { object_slug: "example", record_id: "id" } });
+```
+
+---
+
+<a id="op-getobjectrecordchanges"></a>
+
+### `g8.api.objects.getObjectRecordChanges(input)`
+
+**Get Object Record Changes**
+
+- HTTP: `GET /api/v1/objects/{object_slug}/records/{record_id}/changes`
+- operationId: `get_object_record_changes_objects__object_slug__records__record_id__changes_get` (also callable as `g8.api.call("get_object_record_changes_objects__object_slug__records__record_id__changes_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `objects:read`
+- ★ Hand-written: [`g8.objects.changes()`](../sdk-clients.md#g8-objects-changes)
+
+Read recorded mutation authorship and before/after changes with stable cursor pagination.
+
+Custom records include clear and lifecycle actions. Canonical contacts and companies use
+their existing IDs and audit facts, bounded by current record access and
+field privacy; archived records are unavailable through this reader.
+Older writes without recorded mutation facts are not reconstructed here.
+An unavailable audit store returns 503, never an empty success response.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.record_id` | `string` | yes |  |
+| `query.limit` | `integer` | no | default `100` |
+| `query.cursor` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_RecordMutationsResponse_`: the envelope `{ data: RecordMutationsResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`RecordMutationsResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `entries` | `Array<RecordMutationEntry>` | yes |  |
+| `record_id` | `string` | yes |  |
+| `next_cursor` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.getObjectRecordChanges({ path: { object_slug: "example", record_id: "id" } });
+```
+
+---
+
+<a id="op-getobjectrecordhistory"></a>
+
+### `g8.api.objects.getObjectRecordHistory(input)`
+
+**Get Object Record History**
+
+- HTTP: `GET /api/v1/objects/{object_slug}/records/{record_id}/history`
+- operationId: `get_object_record_history_objects__object_slug__records__record_id__history_get` (also callable as `g8.api.call("get_object_record_history_objects__object_slug__records__record_id__history_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `objects:read`
+- Lifecycle: `preview` (may not be enabled for every org yet)
+- ★ Hand-written: [`g8.objects.history()`](../sdk-clients.md#g8-objects-history)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+A record's value timeline, newest first.
+
+Each entry is one generation of one attribute. An entry whose `active_until`
+is null is the value currently in force.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.record_id` | `string` | yes |  |
+| `query.limit` | `integer` | no | Maximum generations to return default `100` |
+
+**Returns** `ApiResponse_RecordHistoryResponse_`: the envelope `{ data: RecordHistoryResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`RecordHistoryResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `record_id` | `string` | yes |  |
+| `entries` | `Array<RecordHistoryEntry>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.getObjectRecordHistory({ path: { object_slug: "example", record_id: "id" } });
+```
+
+---
+
+<a id="op-getobjectrelationshipdefinitions"></a>
+
+### `g8.api.objects.getObjectRelationshipDefinitions(input)`
+
+**Get Object Relationship Definitions**
+
+- HTTP: `GET /api/v1/objects/{object_slug}/relationships`
+- operationId: `get_object_relationship_definitions_objects__object_slug__relationships_get` (also callable as `g8.api.call("get_object_relationship_definitions_objects__object_slug__relationships_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `objects:read`
+
+Definitions involving a custom or native object, narrowed to the credential's native read scopes.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `query.limit` | `integer` | no | default `50` |
+| `query.offset` | `integer` | no | default `0` |
+
+**Returns** `ApiResponse_RelationshipDefinitionListResponse_`: the envelope `{ data: RelationshipDefinitionListResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`RelationshipDefinitionListResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `relationships` | `Array<RelationshipDefinitionResponse>` | yes |  |
+| `total` | `integer` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.getObjectRelationshipDefinitions({ path: { object_slug: "example" } });
+```
+
+---
+
+<a id="op-getobjectrelationships"></a>
+
+### `g8.api.objects.getObjectRelationships(input)`
+
+**Get Object Relationships**
+
+- HTTP: `GET /api/v1/objects/{object_slug}/records/{record_id}/relationships`
+- operationId: `get_object_relationships_objects__object_slug__records__record_id__relationships_get` (also callable as `g8.api.call("get_object_relationships_objects__object_slug__records__record_id__relationships_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `objects:read`
+
+Read authorized links of a custom or native record, both endpoints filtered
+before pagination. Needs objects:read plus the native kinds' explicit read
+scopes; an absent and an inaccessible record share a neutral 404.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.record_id` | `string` | yes |  |
+| `query.limit` | `integer` | no | default `50` |
+| `query.offset` | `integer` | no | default `0` |
+
+**Returns** `ApiResponse_RecordRelationshipsResponse_`: the envelope `{ data: RecordRelationshipsResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`RecordRelationshipsResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `next_offset` | `integer \| null` | yes | Next visible page offset; null at the end |
+| `relationships` | `Array<RelatedRecordEdge>` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.getObjectRelationships({ path: { object_slug: "example", record_id: "id" } });
+```
+
+---
+
+<a id="op-inspectobjectcsvimport"></a>
+
+### `g8.api.objects.inspectObjectCsvImport(input)`
+
+**Inspect Object Csv Import**
+
+- HTTP: `POST /api/v1/objects/{object_slug}/imports/csv/inspect`
+- operationId: `inspect_object_csv_import_objects__object_slug__imports_csv_inspect_post` (also callable as `g8.api.call("inspect_object_csv_import_objects__object_slug__imports_csv_inspect_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `objects:write`
+
+Read a CSV's headers, five sample rows and row count. Nothing is stored or written. Maximum 2 MB, 5000 rows, 200 columns.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `body` | `ObjectCsvInspect` | yes | Request body; fields below. |
+
+Body fields (`ObjectCsvInspect`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.csv` | `string` | yes | min length 1, max length 2000000 |
+
+**Returns** `ApiResponse_ObjectCsvInspection_`: the envelope `{ data: ObjectCsvInspection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectCsvInspection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `headers` | `Array<string>` | yes |  |
+| `sample` | `Array<Array<string>>` | yes |  |
+| `total` | `integer` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.inspectObjectCsvImport({ path: { object_slug: "example" }, body: { csv: "example" } });
+```
+
+---
+
+<a id="op-listobjectattributes"></a>
+
+### `g8.api.objects.listObjectAttributes(input)`
+
+**List Object Attributes**
+
+- HTTP: `GET /api/v1/objects/{object_slug}/attributes`
+- operationId: `list_object_attributes_objects__object_slug__attributes_get` (also callable as `g8.api.call("list_object_attributes_objects__object_slug__attributes_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `objects:read`
+- Lifecycle: `preview` (may not be enabled for every org yet)
+- ★ Hand-written: [`g8.objects.listAttributes()`](../sdk-clients.md#g8-objects-listattributes)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+List active fields. Archived-field discovery currently applies to custom objects.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `query.include_archived` | `boolean` | no | default `false` |
+
+**Returns** `ApiResponse_list_AttributeDefinitionResponse__`: the envelope `{ data: Array<AttributeDefinitionResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AttributeDefinitionResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `attribute_type` | `string` | yes | One of the 16 supported attribute types (`text`, `number`, `email_address`, `timestamp`, `select`, `record_reference`, …). Determines how values are validated and canonicalized. |
+| `slug` | `string` | yes | Stable API slug for the attribute, used as a payload key. |
+| `title` | `string` | yes | Customer-facing field label, distinct from its stable API slug. |
+| `config` | `Record<string, unknown>` | no | Type-specific configuration, e.g. select options. Record references require target_object and must resolve to active records in that object within the caller's organization and app. |
+| `default_value` | `unknown` | no | Configured create default. Enabled non-null defaults pass the same validation as explicit values. |
+| `description` | `string \| null` | no | Customer-configured description of the field. |
+| `is_archived` | `boolean` | no | Archived fields retain their values and can be restored. default `false` |
+| `is_default_value_enabled` | `boolean` | no | Apply the configured default when this field is omitted on create. Never applies on PATCH. default `false` |
+| `is_multiselect` | `boolean` | no | Values are a list rather than a scalar. default `false` |
+| `is_required` | `boolean` | no | Required on create. PATCH may omit it, but cannot clear it with null or an empty multivalue list. default `false` |
+| `is_system` | `boolean` | no | Whether this field is protected as a system attribute. default `false` |
+| `is_unique` | `boolean` | no | No two active records may hold the same value for this attribute. A collision is rejected with `409 duplicate_active_value`. default `false` |
+| `sort_order` | `integer` | no | Configured display order; equal values are ordered by API slug. default `0` |
+| `visible_to_role_ids` | `Array<string> \| null` | no | Role ids that may see this field; null means every role. Owners and admins always see every field. A field hidden from the caller is absent from every response. Set it with PATCH on this attribute. |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.listObjectAttributes({ path: { object_slug: "example" } });
+```
+
+---
+
+<a id="op-listobjectcsvimports"></a>
+
+### `g8.api.objects.listObjectCsvImports(input)`
+
+**List Object Csv Imports**
+
+- HTTP: `GET /api/v1/objects/{object_slug}/imports/csv/drafts`
+- operationId: `list_object_csv_imports_objects__object_slug__imports_csv_drafts_get` (also callable as `g8.api.call("list_object_csv_imports_objects__object_slug__imports_csv_drafts_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `objects:write`
+
+List this credential's CSV imports for the object, newest first. History only: no file contents or cell values.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `query.limit` | `integer` | no | default `25` |
+| `query.offset` | `integer` | no | default `0` |
+
+**Returns** `ApiResponse_list_ObjectImportSummary__`: the envelope `{ data: Array<ObjectImportSummary>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectImportSummary` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `completed` | `integer` | yes |  |
+| `created_at` | `string (date-time)` | yes |  |
+| `error_rows` | `integer` | yes |  |
+| `expires_at` | `string (date-time)` | yes |  |
+| `filename` | `string` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `owner_id` | `string` | yes |  |
+| `owner_type` | `"user" \| "api"` | yes |  |
+| `revision` | `integer` | yes |  |
+| `source_available` | `boolean` | yes |  |
+| `status` | `"draft" \| "partial" \| "completed" \| "expired"` | yes |  |
+| `total` | `integer` | yes |  |
+| `updated_at` | `string (date-time)` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.listObjectCsvImports({ path: { object_slug: "example" } });
+```
+
+---
+
+<a id="op-listobjectrecords"></a>
+
+### `g8.api.objects.listObjectRecords(input)`
+
+**List Object Records**
+
+- HTTP: `GET /api/v1/objects/{object_slug}/records`
+- operationId: `list_object_records_objects__object_slug__records_get` (also callable as `g8.api.call("list_object_records_objects__object_slug__records_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `objects:read`
+- Lifecycle: `preview` (may not be enabled for every org yet)
+- ★ Hand-written: [`g8.objects.listRecords()`](../sdk-clients.md#g8-objects-listrecords)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+List an object's records, newest last, with their active values.
+
+Archived records are excluded. Supports page-number and opaque cursor
+pagination; when `cursor` is supplied it wins. Deals use canonical UUIDs,
+current ownership scope, typed values and independently permitted references.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `query.page` | `integer` | no | Page number (ignored when `cursor` is supplied) default `1` |
+| `query.limit` | `integer` | no | Items per page default `50` |
+| `query.cursor` | `string \| null` | no | Opaque pagination cursor from a prior response's `next_cursor`. When supplied it takes precedence over `page`. |
+
+**Returns** `ApiResponse_list_ObjectRecordResponse__`: the envelope `{ data: Array<ObjectRecordResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectRecordResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes | Opaque record identifier. |
+| `object_slug` | `string` | yes | The object type this record belongs to. |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `is_archived` | `boolean` | no | Archived records are excluded from listings. default `false` |
+| `revision` | `integer` | no | Record revision for conditional updates. default `1`, min 1 |
+| `updated_at` | `string (date-time) \| null` | no |  |
+| `values` | `Record<string, unknown>` | no | Currently active values, keyed by attribute slug. Shapes follow each attribute's own type; call `GET /objects/{object_slug}/attributes` for the schema. |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.listObjectRecords({ path: { object_slug: "example" } });
+```
+
+---
+
+<a id="op-listobjectviews"></a>
+
+### `g8.api.objects.listObjectViews(input)`
+
+**List Object Views**
+
+- HTTP: `GET /api/v1/objects/{object_slug}/views`
+- operationId: `list_object_views_objects__object_slug__views_get` (also callable as `g8.api.call("list_object_views_objects__object_slug__views_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `objects:read`
+
+List this credential's private views and shared workspace views. Views never grant record access.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+
+**Returns** `ApiResponse_list_SavedViewResponse__`: the envelope `{ data: Array<SavedViewResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SavedViewResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `context_key` | `string \| null` | yes |  |
+| `created_at` | `string (date-time) \| null` | yes |  |
+| `created_by` | `string` | yes |  |
+| `description` | `string \| null` | yes |  |
+| `entity_type` | `EntityType` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `is_default` | `boolean` | yes |  |
+| `is_owner` | `boolean` | yes |  |
+| `is_reusable` | `boolean` | yes |  |
+| `state` | `Record<string, unknown>` | yes |  |
+| `title` | `string` | yes |  |
+| `updated_at` | `string (date-time) \| null` | yes |  |
+| `visibility` | `Visibility` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.listObjectViews({ path: { object_slug: "example" } });
+```
+
+---
+
+<a id="op-listobjects"></a>
+
+### `g8.api.objects.listObjects(input?)`
+
+**List Objects**
+
+- HTTP: `GET /api/v1/objects`
+- operationId: `list_objects_objects_get` (also callable as `g8.api.call("list_objects_objects_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `objects:read`
+- Lifecycle: `preview` (may not be enabled for every org yet)
+- ★ Hand-written: [`g8.objects.list()`](../sdk-clients.md#g8-objects-list)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+List accessible registered standard and custom objects; optionally include archived custom definitions.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.include_archived` | `boolean` | no | default `false` |
+
+**Returns** `ApiResponse_list_ObjectDefinitionResponse__`: the envelope `{ data: Array<ObjectDefinitionResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectDefinitionResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `plural_noun` | `string` | yes | Display name for many records, e.g. "Invoices". |
+| `singular_noun` | `string` | yes | Display name for one record, e.g. "Invoice". |
+| `slug` | `string` | yes | Stable API slug for the object type, e.g. `invoices`. |
+| `description` | `string \| null` | no | Customer-configured object description. |
+| `display_attribute_slug` | `string \| null` | no | Active single-value field used to label records; null uses the default. |
+| `icon` | `string \| null` | no | Configured graph8 icon name; null uses the default. |
+| `is_archived` | `boolean` | no | Archived objects are hidden from listings. default `false` |
+| `is_system` | `boolean` | no | True for objects graph8 ships; system objects cannot be deleted. default `false` |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.listObjects();
+```
+
+---
+
+<a id="op-mergeobjectrecords"></a>
+
+### `g8.api.objects.mergeObjectRecords(input)`
+
+**Merge Object Records**
+
+- HTTP: `POST /api/v1/objects/{object_slug}/records/merge`
+- operationId: `merge_object_records_objects__object_slug__records_merge_post` (also callable as `g8.api.call("merge_object_records_objects__object_slug__records_merge_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `objects:write`
+
+Eligible merge: resolve fields, archive the secondary (its values closed
+first), repoint links and associations onto the primary, write the primary.
+Needs objects:write AND objects:delete — both scope dependencies are real
+parameters so each carries its own ``required_api_key_scope`` marker.
+Delegates to the Studio function (same blockers, field resolution, cascade,
+far-end access rule and ``records_core`` switch).
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `body` | `RecordMergeRequest` | yes | Request body; fields below. |
+
+Body fields (`RecordMergeRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.primary_record_id` | `string (uuid)` | yes |  |
+| `body.secondary_record_id` | `string (uuid)` | yes |  |
+| `body.expected_primary_revision` | `integer \| null` | no | min 1 |
+| `body.expected_secondary_revision` | `integer \| null` | no | min 1 |
+| `body.field_overrides` | `Array<RecordMergeFieldOverride>` | no |  |
+
+**Returns** `ApiResponse_RecordMergeResponse_`: the envelope `{ data: RecordMergeResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`RecordMergeResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `cascade` | `RecordMergeCascade` | yes |  |
+| `merge_history_id` | `string (uuid)` | yes |  |
+| `record` | `RecordResponse` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.mergeObjectRecords({
+  path: { object_slug: "example" },
+  body: {
+    primary_record_id: "00000000-0000-0000-0000-000000000000",
+    secondary_record_id: "00000000-0000-0000-0000-000000000000",
+  },
+});
+```
+
+---
+
+<a id="op-previewobjectcsvimport"></a>
+
+### `g8.api.objects.previewObjectCsvImport(input)`
 
-PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+**Preview Object Csv Import**
 
-List active fields. Archived-field discovery currently applies to custom objects.
+- HTTP: `POST /api/v1/objects/{object_slug}/imports/csv/drafts/{draft_id}/preview`
+- operationId: `preview_object_csv_import_objects__object_slug__imports_csv_drafts__draft_id__preview_post` (also callable as `g8.api.call("preview_object_csv_import_objects__object_slug__imports_csv_drafts__draft_id__preview_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `objects:write`
+
+Preview up to 100 rows of the stored file: normalized values, errors, upsert matches and rows already imported.
+Writes no records. Empty cells are omitted; \N clears a field.
 
 **Input**
 
 | Field | Type | Required | Description |
 |---|---|---|---|
 | `path.object_slug` | `string` | yes |  |
-| `query.include_archived` | `boolean` | no | default `false` |
+| `path.draft_id` | `string (uuid)` | yes |  |
+| `body` | `ImportPage` | yes | Request body; fields below. |
 
-**Returns** `ApiResponse_list_AttributeDefinitionResponse__`: the envelope `{ data: Array<AttributeDefinitionResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+Body fields (`ImportPage`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.revision` | `integer` | yes | The draft revision this page was planned against min 1 |
+| `body.limit` | `integer` | no | default `100`, min 1, max 100 |
+| `body.offset` | `integer` | no | default `0`, min 0, max 4999 |
+
+**Returns** `ApiResponse_ObjectCsvPreview_`: the envelope `{ data: ObjectCsvPreview, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
 
 Other envelope fields: `pagination` (PaginationMeta).
 
-`AttributeDefinitionResponse` fields:
+`ObjectCsvPreview` fields:
 
 | Field | Type | Required | Description |
 |---|---|---|---|
-| `attribute_type` | `string` | yes | One of the 16 supported attribute types (`text`, `number`, `email_address`, `timestamp`, `select`, `record_reference`, …). Determines how values are validated and canonicalized. |
-| `slug` | `string` | yes | Stable API slug for the attribute, used as a payload key. |
-| `title` | `string` | yes | Customer-facing field label, distinct from its stable API slug. |
-| `config` | `Record<string, unknown>` | no | Type-specific configuration, e.g. select options. Record references require target_object and must resolve to active records in that object within the caller's organization and app. |
-| `default_value` | `unknown` | no | Configured create default. Enabled non-null defaults pass the same validation as explicit values. |
-| `description` | `string \| null` | no | Customer-configured description of the field. |
-| `is_archived` | `boolean` | no | Archived fields retain their values and can be restored. default `false` |
-| `is_default_value_enabled` | `boolean` | no | Apply the configured default when this field is omitted on create. Never applies on PATCH. default `false` |
-| `is_multiselect` | `boolean` | no | Values are a list rather than a scalar. default `false` |
-| `is_required` | `boolean` | no | Required on create. PATCH may omit it, but cannot clear it with null or an empty multivalue list. default `false` |
-| `is_system` | `boolean` | no | Whether this field is protected as a system attribute. default `false` |
-| `is_unique` | `boolean` | no | No two active records may hold the same value for this attribute. A collision is rejected with `409 duplicate_active_value`. default `false` |
-| `sort_order` | `integer` | no | Configured display order; equal values are ordered by API slug. default `0` |
+| `completed` | `integer` | yes |  |
+| `next_offset` | `integer \| null` | yes |  |
+| `rows` | `Array<ImportPreviewRow>` | yes |  |
+| `schema_fingerprint` | `string` | yes |  |
+| `total` | `integer` | yes |  |
 
 **Example**
 
 ```ts
-const result = await g8.api.objects.listObjectAttributes({ path: { object_slug: "example" } });
+const result = await g8.api.objects.previewObjectCsvImport({
+  path: {
+    object_slug: "example",
+    draft_id: "00000000-0000-0000-0000-000000000000",
+  },
+  body: { revision: 1 },
+});
 ```
 
 ---
 
-<a id="op-listobjectrecords"></a>
+<a id="op-queryobjectboardgroups"></a>
 
-### `g8.api.objects.listObjectRecords(input)`
+### `g8.api.objects.queryObjectBoardGroups(input)`
 
-**List Object Records**
+**Query Object Board Groups**
 
-- HTTP: `GET /api/v1/objects/{object_slug}/records`
-- operationId: `list_object_records_objects__object_slug__records_get` (also callable as `g8.api.call("list_object_records_objects__object_slug__records_get", input)`)
-- Tier: `read`: reads data; safe to call and to retry
+- HTTP: `POST /api/v1/objects/{object_slug}/views/board/groups`
+- operationId: `query_object_board_groups_objects__object_slug__views_board_groups_post` (also callable as `g8.api.call("query_object_board_groups_objects__object_slug__views_board_groups_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
 - API-key scope: `objects:read`
-- Lifecycle: `preview` (may not be enabled for every org yet)
-- ★ Hand-written: [`g8.objects.listRecords()`](../sdk-clients.md#g8-objects-listrecords)
-
-PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
-
-List an object's records, newest last, with their active values.
 
-Archived records are excluded. Supports page-number and opaque cursor
-pagination; when `cursor` is supplied it wins. Deals use canonical UUIDs,
-current ownership scope, typed values and independently permitted references.
+Read status groups and full filtered counts. This POST performs no writes.
 
 **Input**
 
 | Field | Type | Required | Description |
 |---|---|---|---|
 | `path.object_slug` | `string` | yes |  |
-| `query.page` | `integer` | no | Page number (ignored when `cursor` is supplied) default `1` |
-| `query.limit` | `integer` | no | Items per page default `50` |
-| `query.cursor` | `string \| null` | no | Opaque pagination cursor from a prior response's `next_cursor`. When supplied it takes precedence over `page`. |
+| `body` | `ObjectViewState` | yes | Request body; fields below. |
 
-**Returns** `ApiResponse_list_ObjectRecordResponse__`: the envelope `{ data: Array<ObjectRecordResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+Body fields (`ObjectViewState`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.columns` | `Array<string> \| null` | no | max items 200 |
+| `body.filters` | `Array<RecordFilter>` | no | max items 10 |
+| `body.groupBy` | `string \| null` | no |  |
+| `body.includeArchived` | `boolean` | no | default `false` |
+| `body.layout` | `"table" \| "board"` | no | default `"table"` |
+| `body.search` | `string` | no | default `""`, max length 200 |
+| `body.sortBy` | `string \| null` | no |  |
+| `body.sortOrder` | `"asc" \| "desc"` | no | default `"desc"` |
+| `body.version` | `1` | no | default `1` |
+
+**Returns** `ApiResponse_list_ObjectBoardGroup__`: the envelope `{ data: Array<ObjectBoardGroup>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
 
 Other envelope fields: `pagination` (PaginationMeta).
 
-`ObjectRecordResponse` fields:
+`ObjectBoardGroup` fields:
 
 | Field | Type | Required | Description |
 |---|---|---|---|
-| `id` | `string` | yes | Opaque record identifier. |
-| `object_slug` | `string` | yes | The object type this record belongs to. |
-| `created_at` | `string (date-time) \| null` | no |  |
-| `is_archived` | `boolean` | no | Archived records are excluded from listings. default `false` |
-| `revision` | `integer` | no | Record revision for conditional updates. default `1`, min 1 |
-| `updated_at` | `string (date-time) \| null` | no |  |
-| `values` | `Record<string, unknown>` | no | Currently active values, keyed by attribute slug. Shapes follow each attribute's own type; call `GET /objects/{object_slug}/attributes` for the schema. |
+| `label` | `string` | yes |  |
+| `total` | `integer` | yes |  |
+| `value` | `string \| null` | yes |  |
 
 **Example**
 
 ```ts
-const result = await g8.api.objects.listObjectRecords({ path: { object_slug: "example" } });
+const result = await g8.api.objects.queryObjectBoardGroups({ path: { object_slug: "example" }, body: {} });
 ```
 
 ---
 
-<a id="op-listobjects"></a>
+<a id="op-queryobjectboardrecords"></a>
 
-### `g8.api.objects.listObjects(input?)`
+### `g8.api.objects.queryObjectBoardRecords(input)`
 
-**List Objects**
+**Query Object Board Records**
 
-- HTTP: `GET /api/v1/objects`
-- operationId: `list_objects_objects_get` (also callable as `g8.api.call("list_objects_objects_get", input)`)
-- Tier: `read`: reads data; safe to call and to retry
+- HTTP: `POST /api/v1/objects/{object_slug}/views/board/records`
+- operationId: `query_object_board_records_objects__object_slug__views_board_records_post` (also callable as `g8.api.call("query_object_board_records_objects__object_slug__views_board_records_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
 - API-key scope: `objects:read`
-- Lifecycle: `preview` (may not be enabled for every org yet)
-- ★ Hand-written: [`g8.objects.list()`](../sdk-clients.md#g8-objects-list)
 
-PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
-
-List accessible registered standard and custom objects; optionally include archived custom definitions.
+Read a bounded status page with current record revisions. This POST performs no writes.
 
 **Input**
 
 | Field | Type | Required | Description |
 |---|---|---|---|
-| `query.include_archived` | `boolean` | no | default `false` |
+| `path.object_slug` | `string` | yes |  |
+| `body` | `ObjectBoardPage` | yes | Request body; fields below. |
 
-**Returns** `ApiResponse_list_ObjectDefinitionResponse__`: the envelope `{ data: Array<ObjectDefinitionResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+Body fields (`ObjectBoardPage`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.state` | `ObjectViewState` | yes |  |
+| `body.group_value` | `string \| null` | no | max length 500 |
+| `body.limit` | `integer` | no | default `20`, min 1, max 50 |
+| `body.offset` | `integer` | no | default `0`, min 0, max 1000000 |
+
+**Returns** `ApiResponse_RecordListResponse_`: the envelope `{ data: RecordListResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
 
 Other envelope fields: `pagination` (PaginationMeta).
 
-`ObjectDefinitionResponse` fields:
+`RecordListResponse` fields:
 
 | Field | Type | Required | Description |
 |---|---|---|---|
-| `plural_noun` | `string` | yes | Display name for many records, e.g. "Invoices". |
-| `singular_noun` | `string` | yes | Display name for one record, e.g. "Invoice". |
-| `slug` | `string` | yes | Stable API slug for the object type, e.g. `invoices`. |
-| `description` | `string \| null` | no | Customer-configured object description. |
-| `display_attribute_slug` | `string \| null` | no | Active single-value field used to label records; null uses the default. |
-| `icon` | `string \| null` | no | Configured graph8 icon name; null uses the default. |
-| `is_archived` | `boolean` | no | Archived objects are hidden from listings. default `false` |
-| `is_system` | `boolean` | no | True for objects graph8 ships; system objects cannot be deleted. default `false` |
+| `records` | `Array<RecordResponse>` | yes |  |
+| `total` | `integer` | yes |  |
 
 **Example**
 
 ```ts
-const result = await g8.api.objects.listObjects();
+const result = await g8.api.objects.queryObjectBoardRecords({ path: { object_slug: "example" }, body: { state: {} } });
 ```
 
 ---
@@ -790,6 +1872,62 @@ const result = await g8.api.objects.restoreObjectRecord({ path: { object_slug: "
 
 ---
 
+<a id="op-setdefaultobjectview"></a>
+
+### `g8.api.objects.setDefaultObjectView(input)`
+
+**Set Default Object View**
+
+- HTTP: `PUT /api/v1/objects/{object_slug}/views/default`
+- operationId: `set_default_object_view_objects__object_slug__views_default_put` (also callable as `g8.api.call("set_default_object_view_objects__object_slug__views_default_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `objects:write`
+
+Set or clear this credential's default within this object. Human defaults are unaffected.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `body` | `ObjectViewDefault` | yes | Request body; fields below. |
+
+Body fields (`ObjectViewDefault`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.view_id` | `string (uuid) \| null` | no |  |
+
+**Returns** `ApiResponse_Union_SavedViewResponse__NoneType__`: the envelope `{ data: SavedViewResponse | null, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`data` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `context_key` | `string \| null` | yes |  |
+| `created_at` | `string (date-time) \| null` | yes |  |
+| `created_by` | `string` | yes |  |
+| `description` | `string \| null` | yes |  |
+| `entity_type` | `EntityType` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `is_default` | `boolean` | yes |  |
+| `is_owner` | `boolean` | yes |  |
+| `is_reusable` | `boolean` | yes |  |
+| `state` | `Record<string, unknown>` | yes |  |
+| `title` | `string` | yes |  |
+| `updated_at` | `string (date-time) \| null` | yes |  |
+| `visibility` | `Visibility` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.setDefaultObjectView({ path: { object_slug: "example" }, body: {} });
+```
+
+---
+
 <a id="op-updateattribute"></a>
 
 ### `g8.api.objects.updateAttribute(input)`
@@ -826,6 +1964,7 @@ Body fields (`AttributeUpdateRequest`):
 | `body.is_unique` | `boolean \| null` | no |  |
 | `body.sort_order` | `integer \| null` | no |  |
 | `body.title` | `string \| null` | no | min length 1, max length 200 |
+| `body.visible_to_role_ids` | `Array<string (uuid)> \| null` | no | max items 100 |
 
 **Returns** `ApiResponse_AttributeDefinitionResponse_`: the envelope `{ data: AttributeDefinitionResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
 
@@ -848,6 +1987,7 @@ Other envelope fields: `pagination` (PaginationMeta).
 | `is_system` | `boolean` | no | Whether this field is protected as a system attribute. default `false` |
 | `is_unique` | `boolean` | no | No two active records may hold the same value for this attribute. A collision is rejected with `409 duplicate_active_value`. default `false` |
 | `sort_order` | `integer` | no | Configured display order; equal values are ordered by API slug. default `0` |
+| `visible_to_role_ids` | `Array<string> \| null` | no | Role ids that may see this field; null means every role. Owners and admins always see every field. A field hidden from the caller is absent from every response. Set it with PATCH on this attribute. |
 
 **Example**
 
@@ -917,6 +2057,77 @@ const result = await g8.api.objects.updateObject({ path: { object_slug: "example
 
 ---
 
+<a id="op-updateobjectcsvimport"></a>
+
+### `g8.api.objects.updateObjectCsvImport(input)`
+
+**Update Object Csv Import**
+
+- HTTP: `PUT /api/v1/objects/{object_slug}/imports/csv/drafts/{draft_id}`
+- operationId: `update_object_csv_import_objects__object_slug__imports_csv_drafts__draft_id__put` (also callable as `g8.api.call("update_object_csv_import_objects__object_slug__imports_csv_drafts__draft_id__put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `objects:write`
+
+Change the filename or setup. revision must be the import's current revision. The stored file never changes.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.draft_id` | `string (uuid)` | yes |  |
+| `query.revision` | `integer` | yes |  |
+| `body` | `ObjectImportUpdate` | yes | Request body; fields below. |
+
+Body fields (`ObjectImportUpdate`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.filename` | `string` | yes | min length 1, max length 255 |
+| `body.mapping` | `Record<string, string>` | no |  |
+| `body.matching_attribute` | `string \| null` | no | max length 100 |
+| `body.mode` | `"create" \| "upsert"` | no | default `"create"` |
+
+**Returns** `ApiResponse_ObjectImportDetail_`: the envelope `{ data: ObjectImportDetail, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectImportDetail` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `completed` | `integer` | yes |  |
+| `created_at` | `string (date-time)` | yes |  |
+| `error_rows` | `integer` | yes |  |
+| `expires_at` | `string (date-time)` | yes |  |
+| `filename` | `string` | yes |  |
+| `headers` | `Array<string>` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `owner_id` | `string` | yes |  |
+| `owner_type` | `"user" \| "api"` | yes |  |
+| `revision` | `integer` | yes |  |
+| `setup` | `ObjectImportSetup` | yes |  |
+| `source_available` | `boolean` | yes |  |
+| `status` | `"draft" \| "partial" \| "completed" \| "expired"` | yes |  |
+| `total` | `integer` | yes |  |
+| `updated_at` | `string (date-time)` | yes |  |
+| `sample` | `Array<Array<string>>` | no | First rows of the file while it is still stored |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.updateObjectCsvImport({
+  path: {
+    object_slug: "example",
+    draft_id: "00000000-0000-0000-0000-000000000000",
+  },
+  query: { revision: 1 },
+  body: { filename: "Example" },
+});
+```
+
+---
+
 <a id="op-updateobjectrecord"></a>
 
 ### `g8.api.objects.updateObjectRecord(input)`
@@ -980,6 +2191,70 @@ const result = await g8.api.objects.updateObjectRecord({ path: { object_slug: "e
 
 ---
 
+<a id="op-updateobjectview"></a>
+
+### `g8.api.objects.updateObjectView(input)`
+
+**Update Object View**
+
+- HTTP: `PUT /api/v1/objects/{object_slug}/views/{view_id}`
+- operationId: `update_object_view_objects__object_slug__views__view_id__put` (also callable as `g8.api.call("update_object_view_objects__object_slug__views__view_id__put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `objects:write`
+
+Rename or replace settings on a view owned by this credential.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.view_id` | `string (uuid)` | yes |  |
+| `body` | `ObjectViewUpdate` | yes | Request body; fields below. |
+
+Body fields (`ObjectViewUpdate`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.state` | `ObjectViewState \| null` | no |  |
+| `body.title` | `string \| null` | no | min length 1, max length 120 |
+
+**Returns** `ApiResponse_SavedViewResponse_`: the envelope `{ data: SavedViewResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SavedViewResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `context_key` | `string \| null` | yes |  |
+| `created_at` | `string (date-time) \| null` | yes |  |
+| `created_by` | `string` | yes |  |
+| `description` | `string \| null` | yes |  |
+| `entity_type` | `EntityType` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `is_default` | `boolean` | yes |  |
+| `is_owner` | `boolean` | yes |  |
+| `is_reusable` | `boolean` | yes |  |
+| `state` | `Record<string, unknown>` | yes |  |
+| `title` | `string` | yes |  |
+| `updated_at` | `string (date-time) \| null` | yes |  |
+| `visibility` | `Visibility` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.objects.updateObjectView({
+  path: {
+    object_slug: "example",
+    view_id: "00000000-0000-0000-0000-000000000000",
+  },
+  body: {},
+});
+```
+
+---
+
 <a id="op-upsertobjectrecord"></a>
 
 ### `g8.api.objects.upsertObjectRecord(input)`
@@ -1065,6 +2340,97 @@ Valid attribute types for the Custom Objects type system.
 
 Type: `"text" | "number" | "currency" | "date" | "timestamp" | "checkbox" | "select" | "status" | …`.
 
+<a id="type-entitytype"></a>
+
+### `EntityType`
+
+Which CRM grid the saved view applies to. Free-form string at the DB level (cb_saved_views.entity_type is VARCHAR(50)) to avoid a schema migration when we add deals/tasks/leads — but enforced as an enum at the API boundary so we don't accept typos. NEITHER A SUBSET NOR A SUPERSET OF ``FilterEntityType`` — see the invariant on that class, and the sibling docstring below, which states the same relationship from the other side. The two enums overlap on the four GRID values (``contacts``, ``companies``, ``deals``, ``leads``); ``FilterEntityType`` is a superset of THOSE and adds ``report``, while…
+
+Type: `"custom_objects" | "contacts" | "companies" | "deals" | "leads" | "lists" | "contacts_view" | "companies_view" | …`.
+
+<a id="type-importpreviewrow"></a>
+
+### `ImportPreviewRow`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `row_number` | `integer` | yes | min 2 |
+| `already_imported` | `boolean` | no | default `false` |
+| `errors` | `Array<Record<string, unknown>>` | no |  |
+| `record_id` | `string (uuid) \| null` | no |  |
+| `revision` | `integer \| null` | no | min 1 |
+| `values` | `Record<string, unknown>` | no |  |
+
+<a id="type-importreceiptrow"></a>
+
+### `ImportReceiptRow`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `action` | `"created" \| "updated"` | yes |  |
+| `record_id` | `string (uuid)` | yes |  |
+| `revision` | `integer` | yes |  |
+| `row_number` | `integer` | yes |  |
+| `replayed` | `boolean` | no | default `false` |
+
+<a id="type-importrowexpectation"></a>
+
+### `ImportRowExpectation`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `row_number` | `integer` | yes | min 2 |
+| `record_id` | `string (uuid) \| null` | no |  |
+| `revision` | `integer \| null` | no | min 1 |
+
+<a id="type-importskippedrow"></a>
+
+### `ImportSkippedRow`
+
+A row this commit did not import; its errors are kept for the error file.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `errors` | `Array<Record<string, unknown>>` | yes |  |
+| `row_number` | `integer` | yes |  |
+
+<a id="type-objectimportsetup"></a>
+
+### `ObjectImportSetup`
+
+Column mapping (CSV header -> field slug) and match mode. May be incomplete while saved; preview and commit need an executable setup.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `mapping` | `Record<string, string>` | no |  |
+| `matching_attribute` | `string \| null` | no | max length 100 |
+| `mode` | `"create" \| "upsert"` | no | default `"create"` |
+
+<a id="type-recordbulkupdatefailure"></a>
+
+### `RecordBulkUpdateFailure`
+
+One record a bulk update did not change. ``error`` is the human message (kept for existing clients); ``code`` is stable for UIs to branch on: locked, archived, not_found, scope_changed, unique_conflict, invalid_value, constraint_violation or rejected; ``attribute_slug`` names the field when one field caused it.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `error` | `string` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `attribute_slug` | `string \| null` | no |  |
+| `code` | `string` | no | default `"rejected"` |
+
+<a id="type-recordfilter"></a>
+
+### `RecordFilter`
+
+Filter parameters for listing records.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `attribute_slug` | `string` | yes |  |
+| `operator` | `"eq" \| "ne" \| "gt" \| "gte" \| "lt" \| "lte" \| "contains" \| "starts_with" \| …` | yes |  |
+| `value` | `unknown \| null` | no |  |
+
 <a id="type-recordhistoryentry"></a>
 
 ### `RecordHistoryEntry`
@@ -1079,6 +2445,26 @@ One generation of one attribute's value. Values are TEMPORAL rather than mutable
 | `actor_id` | `string \| null` | no | Opaque id of whoever set it. |
 | `value` | `unknown` | no | The value held during this generation. |
 
+<a id="type-recordmergecascade"></a>
+
+### `RecordMergeCascade`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `associations_deleted` | `integer` | yes |  |
+| `associations_repointed` | `integer` | yes |  |
+| `relationships_deleted` | `integer` | yes |  |
+| `relationships_repointed` | `integer` | yes |  |
+
+<a id="type-recordmergefieldoverride"></a>
+
+### `RecordMergeFieldOverride`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `attribute_slug` | `string` | yes |  |
+| `winner` | `"primary" \| "secondary"` | yes |  |
+
 <a id="type-recordmutationentry"></a>
 
 ### `RecordMutationEntry`
@@ -1096,3 +2482,70 @@ One generation of one attribute's value. Values are TEMPORAL rather than mutable
 | `source` | `string` | yes |  |
 | `was_archived` | `boolean` | yes |  |
 | `app_id` | `string \| null` | no |  |
+
+<a id="type-recordresponse"></a>
+
+### `RecordResponse`
+
+Response for a record with its current attribute values.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `created_at` | `string (date-time)` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `is_archived` | `boolean` | yes |  |
+| `object_definition_id` | `string (uuid)` | yes |  |
+| `organization_id` | `string` | yes |  |
+| `updated_at` | `string (date-time)` | yes |  |
+| `values` | `Record<string, unknown>` | yes |  |
+| `revision` | `integer` | no | default `1`, min 1 |
+
+<a id="type-relatedrecordedge"></a>
+
+### `RelatedRecordEdge`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `can_unlink` | `boolean` | yes |  |
+| `definition_id` | `string (uuid)` | yes |  |
+| `definition_revision` | `integer` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `relationship_label` | `string` | yes |  |
+| `source_kind` | `"custom" \| "contacts" \| "companies" \| "deals"` | yes |  |
+| `source_label` | `string \| null` | yes |  |
+| `source_object_slug` | `string` | yes |  |
+| `source_record_id` | `string` | yes |  |
+| `source_revision` | `integer` | yes |  |
+| `target_kind` | `"custom" \| "contacts" \| "companies" \| "deals"` | yes |  |
+| `target_label` | `string \| null` | yes |  |
+| `target_object_slug` | `string` | yes |  |
+| `target_record_id` | `string` | yes |  |
+| `target_revision` | `integer` | yes |  |
+
+<a id="type-relationshipdefinitionresponse"></a>
+
+### `RelationshipDefinitionResponse`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `api_slug` | `string` | yes |  |
+| `created_at` | `string (date-time)` | yes |  |
+| `id` | `string (uuid)` | yes |  |
+| `is_archived` | `boolean` | yes |  |
+| `revision` | `integer` | yes |  |
+| `source_kind` | `string` | yes |  |
+| `source_label` | `string` | yes |  |
+| `source_many` | `boolean` | yes |  |
+| `source_object_definition_id` | `string (uuid) \| null` | yes |  |
+| `target_kind` | `string` | yes |  |
+| `target_label` | `string` | yes |  |
+| `target_many` | `boolean` | yes |  |
+| `target_object_definition_id` | `string (uuid) \| null` | yes |  |
+
+<a id="type-visibility"></a>
+
+### `Visibility`
+
+Who can apply a view. Only the creator can update or delete it.
+
+Type: `"private" | "org"`.