Change Requests

Create Node tree change request

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

message?string

Explanation shown to the human reviewer. Write a conventional-commit style subject — imperative verb + what + why, e.g. "Reorganize marketing docs under a Campaigns folder".

Default"Update node tree"

submittedBy?string

Default"local-producer"

autoMerge?boolean

Whether to approve and merge this structural node change immediately. Omitted defaults to merging immediately if the actor has write access on every target node, otherwise falling back to a pending Change Request; pass explicit false to force review even with write access.

operations*array<||||>

Items1 <= items

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/nodes/change-requests" \  -H "Content-Type: application/json" \  -d '{    "operations": [      {        "kind": "create",        "nodeType": "folder",        "slug": "string",        "name": "string"      }    ]  }'

{  "id": "string",  "baseId": "string",  "targetType": "base",  "nodeId": "string",  "status": "in_review",  "submittedBy": "string",  "submittedByUser": null,  "sourceAttribution": {    "displayName": "string",    "ownerName": "string",    "channel": "web_ui"  },  "sourceMeta": {    "property1": null,    "property2": null  },  "reviewPolicySnapshot": {    "property1": null,    "property2": null  },  "mergeSummary": {    "property1": null,    "property2": null  },  "rejectedReason": "string",  "reviewedAt": "string",  "mergedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "base": {    "id": "string",    "nodeId": "string",    "slug": "string",    "name": "string",    "description": "string",    "reviewPolicy": {      "kind": "single",      "requiredApprovals": 0    },    "createdAt": "string",    "fields": [      {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "type": "text",        "required": true,        "position": 0,        "options": {}      }    ]  },  "node": {    "id": "string",    "parentId": "string",    "type": "folder",    "slug": "string",    "name": "string",    "description": "string",    "metadata": {},    "settings": {},    "explicitVisibility": null,    "icon": null,    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "baseId": "string",    "children": [      {        "id": "string",        "parentId": "string",        "type": "folder",        "slug": "string",        "name": "string",        "description": "string",        "metadata": {},        "settings": {},        "explicitVisibility": null,        "icon": null,        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "baseId": "string",        "children": [          null        ],        "hasChildren": true,        "shared": true      }    ],    "hasChildren": true,    "shared": true  },  "operations": [    {      "id": "string",      "changeRequestId": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operation": "node_create",      "status": "pending",      "targetRecordId": "string",      "targetViewId": "string",      "filePath": "string",      "sourceRecordId": "string",      "sourceCommitId": "string",      "baseCommitId": "string",      "headCommitId": "string",      "deleteMode": "archive",      "mergedRecordId": "string",      "mergedViewId": "string",      "position": 0,      "createdAt": "string",      "updatedAt": "string",      "headCommit": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operationId": "string",        "parentCommitId": "string",        "payload": {          "property1": null,          "property2": null        },        "operation": "node_create",        "message": "string",        "author": "string",        "authorUser": null,        "createdAt": "string"      },      "baseFields": {        "property1": null,        "property2": null      }    }  ],  "primaryOperation": {    "id": "string",    "changeRequestId": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "operation": "node_create",    "status": "pending",    "targetRecordId": "string",    "targetViewId": "string",    "filePath": "string",    "sourceRecordId": "string",    "sourceCommitId": "string",    "baseCommitId": "string",    "headCommitId": "string",    "deleteMode": "archive",    "mergedRecordId": "string",    "mergedViewId": "string",    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "headCommit": {      "id": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operationId": "string",      "parentCommitId": "string",      "payload": {        "property1": null,        "property2": null      },      "operation": "node_create",      "message": "string",      "author": "string",      "authorUser": null,      "createdAt": "string"    },    "baseFields": {      "property1": null,      "property2": null    }  },  "operationCount": 0,  "reviews": [    {      "id": "string",      "changeRequestId": "string",      "reviewerId": "string",      "reviewer": null,      "verdict": "approved",      "reason": "string",      "visibleOperationHeads": {        "property1": "string",        "property2": "string"      },      "createdAt": "string"    }  ]}

Update node content

Path Parameters

nodeId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

content*|||

message?string

Explanation shown to the human reviewer. Write a conventional-commit style subject — imperative verb + what + why, e.g. "Add rollback steps to the deploy runbook".

Default"Update content"

submittedBy?string

Default"local-producer"

autoMerge?boolean

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/nodes/string/content" \  -H "Content-Type: application/json" \  -d '{    "content": {      "kind": "doc",      "body": "string"    }  }'

{  "id": "string",  "baseId": "string",  "targetType": "base",  "nodeId": "string",  "status": "in_review",  "submittedBy": "string",  "submittedByUser": null,  "sourceAttribution": {    "displayName": "string",    "ownerName": "string",    "channel": "web_ui"  },  "sourceMeta": {    "property1": null,    "property2": null  },  "reviewPolicySnapshot": {    "property1": null,    "property2": null  },  "mergeSummary": {    "property1": null,    "property2": null  },  "rejectedReason": "string",  "reviewedAt": "string",  "mergedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "base": {    "id": "string",    "nodeId": "string",    "slug": "string",    "name": "string",    "description": "string",    "reviewPolicy": {      "kind": "single",      "requiredApprovals": 0    },    "createdAt": "string",    "fields": [      {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "type": "text",        "required": true,        "position": 0,        "options": {}      }    ]  },  "node": {    "id": "string",    "parentId": "string",    "type": "folder",    "slug": "string",    "name": "string",    "description": "string",    "metadata": {},    "settings": {},    "explicitVisibility": null,    "icon": null,    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "baseId": "string",    "children": [      {        "id": "string",        "parentId": "string",        "type": "folder",        "slug": "string",        "name": "string",        "description": "string",        "metadata": {},        "settings": {},        "explicitVisibility": null,        "icon": null,        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "baseId": "string",        "children": [          null        ],        "hasChildren": true,        "shared": true      }    ],    "hasChildren": true,    "shared": true  },  "operations": [    {      "id": "string",      "changeRequestId": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operation": "node_create",      "status": "pending",      "targetRecordId": "string",      "targetViewId": "string",      "filePath": "string",      "sourceRecordId": "string",      "sourceCommitId": "string",      "baseCommitId": "string",      "headCommitId": "string",      "deleteMode": "archive",      "mergedRecordId": "string",      "mergedViewId": "string",      "position": 0,      "createdAt": "string",      "updatedAt": "string",      "headCommit": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operationId": "string",        "parentCommitId": "string",        "payload": {          "property1": null,          "property2": null        },        "operation": "node_create",        "message": "string",        "author": "string",        "authorUser": null,        "createdAt": "string"      },      "baseFields": {        "property1": null,        "property2": null      }    }  ],  "primaryOperation": {    "id": "string",    "changeRequestId": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "operation": "node_create",    "status": "pending",    "targetRecordId": "string",    "targetViewId": "string",    "filePath": "string",    "sourceRecordId": "string",    "sourceCommitId": "string",    "baseCommitId": "string",    "headCommitId": "string",    "deleteMode": "archive",    "mergedRecordId": "string",    "mergedViewId": "string",    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "headCommit": {      "id": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operationId": "string",      "parentCommitId": "string",      "payload": {        "property1": null,        "property2": null      },      "operation": "node_create",      "message": "string",      "author": "string",      "authorUser": null,      "createdAt": "string"    },    "baseFields": {      "property1": null,      "property2": null    }  },  "operationCount": 0,  "reviews": [    {      "id": "string",      "changeRequestId": "string",      "reviewerId": "string",      "reviewer": null,      "verdict": "approved",      "reason": "string",      "visibleOperationHeads": {        "property1": "string",        "property2": "string"      },      "createdAt": "string"    }  ]}

Create Change Request in Base

Path Parameters

baseId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fields*

Record field values keyed by field slug. The base's PRIMARY field (its first field) becomes the record's display name and the change request title everywhere — always give it a short, human-readable value, never an id or placeholder.

message?string

Explanation shown to the human reviewer. Write a conventional-commit style subject — imperative verb + what + why, e.g. "Add Acme Corp — qualified lead from the June webinar".

Default"Initial change request"

submittedBy?string

Default"local-producer"

idempotencyKey?string

Optional client-supplied key that dedupes retries. Scoped per base + submitter: calling this endpoint again with the SAME idempotencyKey (e.g. after a timeout or a 5xx where you couldn't tell if the first call succeeded) returns the change request created by the first call instead of creating a duplicate. Omit for normal one-shot calls; only set it when you might retry.

autoMerge?boolean

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/bases/string/change-requests" \  -H "Content-Type: application/json" \  -d '{    "fields": {      "property1": null,      "property2": null    }  }'

{  "id": "string",  "baseId": "string",  "headCommitId": "string",  "parentRecordId": "string",  "parentCommitId": "string",  "status": "active",  "createdBy": "string",  "createdByUser": null,  "fieldUsers": {},  "archivedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "base": {    "id": "string",    "nodeId": "string",    "slug": "string",    "name": "string",    "description": "string",    "reviewPolicy": {      "kind": "single",      "requiredApprovals": 0    },    "createdAt": "string",    "fields": [      {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "type": "text",        "required": true,        "position": 0,        "options": {}      }    ]  },  "headCommit": {    "id": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "operationId": "string",    "parentCommitId": "string",    "payload": {      "property1": null,      "property2": null    },    "operation": "node_create",    "message": "string",    "author": "string",    "authorUser": null,    "createdAt": "string"  },  "materialized": true}

Create bulk record Change Request in Base

Path Parameters

baseId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

records*array<>

Field-value maps, one per record to create, each keyed by field slug. All records are proposed as a SINGLE change request (one review, one merge) — use this to import/seed many rows at once instead of one change request per record. Capped at 1000; for very large loads prefer a dedicated import job. Always give each record's PRIMARY field a short human-readable value.

Items1 <= items <= 1000

message?string

Explanation shown to the human reviewer for the whole batch — e.g. "Import 240 June webinar leads".

Default"Bulk create records"

submittedBy?string

Default"local-producer"

idempotencyKey?string

Optional client-supplied key that dedupes retries. Scoped per base + submitter: calling this endpoint again with the SAME idempotencyKey returns the bulk change request created by the first call instead of creating a duplicate. Omit for normal one-shot calls; only set it when you might retry.

autoMerge?boolean

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/bases/string/records/bulk-change-request" \  -H "Content-Type: application/json" \  -d '{    "records": [      {        "property1": null,        "property2": null      }    ]  }'

{  "id": "string",  "baseId": "string",  "targetType": "base",  "nodeId": "string",  "status": "in_review",  "submittedBy": "string",  "submittedByUser": null,  "sourceAttribution": {    "displayName": "string",    "ownerName": "string",    "channel": "web_ui"  },  "sourceMeta": {    "property1": null,    "property2": null  },  "reviewPolicySnapshot": {    "property1": null,    "property2": null  },  "mergeSummary": {    "property1": null,    "property2": null  },  "rejectedReason": "string",  "reviewedAt": "string",  "mergedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "base": {    "id": "string",    "nodeId": "string",    "slug": "string",    "name": "string",    "description": "string",    "reviewPolicy": {      "kind": "single",      "requiredApprovals": 0    },    "createdAt": "string",    "fields": [      {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "type": "text",        "required": true,        "position": 0,        "options": {}      }    ]  },  "node": {    "id": "string",    "parentId": "string",    "type": "folder",    "slug": "string",    "name": "string",    "description": "string",    "metadata": {},    "settings": {},    "explicitVisibility": null,    "icon": null,    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "baseId": "string",    "children": [      {        "id": "string",        "parentId": "string",        "type": "folder",        "slug": "string",        "name": "string",        "description": "string",        "metadata": {},        "settings": {},        "explicitVisibility": null,        "icon": null,        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "baseId": "string",        "children": [          null        ],        "hasChildren": true,        "shared": true      }    ],    "hasChildren": true,    "shared": true  },  "operations": [    {      "id": "string",      "changeRequestId": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operation": "node_create",      "status": "pending",      "targetRecordId": "string",      "targetViewId": "string",      "filePath": "string",      "sourceRecordId": "string",      "sourceCommitId": "string",      "baseCommitId": "string",      "headCommitId": "string",      "deleteMode": "archive",      "mergedRecordId": "string",      "mergedViewId": "string",      "position": 0,      "createdAt": "string",      "updatedAt": "string",      "headCommit": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operationId": "string",        "parentCommitId": "string",        "payload": {          "property1": null,          "property2": null        },        "operation": "node_create",        "message": "string",        "author": "string",        "authorUser": null,        "createdAt": "string"      },      "baseFields": {        "property1": null,        "property2": null      }    }  ],  "primaryOperation": {    "id": "string",    "changeRequestId": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "operation": "node_create",    "status": "pending",    "targetRecordId": "string",    "targetViewId": "string",    "filePath": "string",    "sourceRecordId": "string",    "sourceCommitId": "string",    "baseCommitId": "string",    "headCommitId": "string",    "deleteMode": "archive",    "mergedRecordId": "string",    "mergedViewId": "string",    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "headCommit": {      "id": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operationId": "string",      "parentCommitId": "string",      "payload": {        "property1": null,        "property2": null      },      "operation": "node_create",      "message": "string",      "author": "string",      "authorUser": null,      "createdAt": "string"    },    "baseFields": {      "property1": null,      "property2": null    }  },  "operationCount": 0,  "reviews": [    {      "id": "string",      "changeRequestId": "string",      "reviewerId": "string",      "reviewer": null,      "verdict": "approved",      "reason": "string",      "visibleOperationHeads": {        "property1": "string",        "property2": "string"      },      "createdAt": "string"    }  ]}

Create bulk record update Change Request in Base

Path Parameters

baseId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

updates*array<>

Items1 <= items <= 1000

message?string

Default"Bulk update records"

submittedBy?string

Default"local-producer"

idempotencyKey?string

autoMerge?boolean

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/bases/string/records/bulk-update-change-request" \  -H "Content-Type: application/json" \  -d '{    "updates": [      {        "recordId": "string",        "fields": {          "property1": null,          "property2": null        }      }    ]  }'

{  "id": "string",  "baseId": "string",  "targetType": "base",  "nodeId": "string",  "status": "in_review",  "submittedBy": "string",  "submittedByUser": null,  "sourceAttribution": {    "displayName": "string",    "ownerName": "string",    "channel": "web_ui"  },  "sourceMeta": {    "property1": null,    "property2": null  },  "reviewPolicySnapshot": {    "property1": null,    "property2": null  },  "mergeSummary": {    "property1": null,    "property2": null  },  "rejectedReason": "string",  "reviewedAt": "string",  "mergedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "base": {    "id": "string",    "nodeId": "string",    "slug": "string",    "name": "string",    "description": "string",    "reviewPolicy": {      "kind": "single",      "requiredApprovals": 0    },    "createdAt": "string",    "fields": [      {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "type": "text",        "required": true,        "position": 0,        "options": {}      }    ]  },  "node": {    "id": "string",    "parentId": "string",    "type": "folder",    "slug": "string",    "name": "string",    "description": "string",    "metadata": {},    "settings": {},    "explicitVisibility": null,    "icon": null,    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "baseId": "string",    "children": [      {        "id": "string",        "parentId": "string",        "type": "folder",        "slug": "string",        "name": "string",        "description": "string",        "metadata": {},        "settings": {},        "explicitVisibility": null,        "icon": null,        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "baseId": "string",        "children": [          null        ],        "hasChildren": true,        "shared": true      }    ],    "hasChildren": true,    "shared": true  },  "operations": [    {      "id": "string",      "changeRequestId": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operation": "node_create",      "status": "pending",      "targetRecordId": "string",      "targetViewId": "string",      "filePath": "string",      "sourceRecordId": "string",      "sourceCommitId": "string",      "baseCommitId": "string",      "headCommitId": "string",      "deleteMode": "archive",      "mergedRecordId": "string",      "mergedViewId": "string",      "position": 0,      "createdAt": "string",      "updatedAt": "string",      "headCommit": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operationId": "string",        "parentCommitId": "string",        "payload": {          "property1": null,          "property2": null        },        "operation": "node_create",        "message": "string",        "author": "string",        "authorUser": null,        "createdAt": "string"      },      "baseFields": {        "property1": null,        "property2": null      }    }  ],  "primaryOperation": {    "id": "string",    "changeRequestId": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "operation": "node_create",    "status": "pending",    "targetRecordId": "string",    "targetViewId": "string",    "filePath": "string",    "sourceRecordId": "string",    "sourceCommitId": "string",    "baseCommitId": "string",    "headCommitId": "string",    "deleteMode": "archive",    "mergedRecordId": "string",    "mergedViewId": "string",    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "headCommit": {      "id": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operationId": "string",      "parentCommitId": "string",      "payload": {        "property1": null,        "property2": null      },      "operation": "node_create",      "message": "string",      "author": "string",      "authorUser": null,      "createdAt": "string"    },    "baseFields": {      "property1": null,      "property2": null    }  },  "operationCount": 0,  "reviews": [    {      "id": "string",      "changeRequestId": "string",      "reviewerId": "string",      "reviewer": null,      "verdict": "approved",      "reason": "string",      "visibleOperationHeads": {        "property1": "string",        "property2": "string"      },      "createdAt": "string"    }  ]}

Create field change request

Path Parameters

baseId*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|

slug?string

Match^[a-z0-9_-]+$

Length1 <= length

type?string

Default"text"

Value in

"text"
"longtext"
"markdown"
"html"
"attachment"
"relation"
"member"
"number"
"date"
"checkbox"
"select"
"multiselect"
"url"
"embed"
"email"
"phone"
"created_time"
"updated_time"
"created_by"
"updated_by"
"auto_number"
"ai_summary"
"ai_tags"
"code"
"json"
"yaml"
"formula"
"lookup"
"whiteboard"

required?boolean

Defaultfalse

options?

Default{}

message?|string

submittedBy?string

Default"local-editor"

autoMerge?||

fieldId?string

Length1 <= length

patch?

newType?string

Value in

"text"
"longtext"
"markdown"
"html"
"attachment"
"relation"
"member"
"number"
"date"
"checkbox"
"select"
"multiselect"
"url"
"embed"
"email"
"phone"
"created_time"
"updated_time"
"created_by"
"updated_by"
"auto_number"
"ai_summary"
"ai_tags"
"code"
"json"
"yaml"
"formula"
"lookup"
"whiteboard"

selectChoiceMode?string

Default"null_on_missing"

Value in

"auto_create"
"null_on_missing"

fieldIds?array<string>

Items1 <= items

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/bases/string/fields/change-requests" \  -H "Content-Type: application/json" \  -d '{    "operation": "create"  }'

{  "id": "string",  "baseId": "string",  "targetType": "base",  "nodeId": "string",  "status": "in_review",  "submittedBy": "string",  "submittedByUser": null,  "sourceAttribution": {    "displayName": "string",    "ownerName": "string",    "channel": "web_ui"  },  "sourceMeta": {    "property1": null,    "property2": null  },  "reviewPolicySnapshot": {    "property1": null,    "property2": null  },  "mergeSummary": {    "property1": null,    "property2": null  },  "rejectedReason": "string",  "reviewedAt": "string",  "mergedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "base": {    "id": "string",    "nodeId": "string",    "slug": "string",    "name": "string",    "description": "string",    "reviewPolicy": {      "kind": "single",      "requiredApprovals": 0    },    "createdAt": "string",    "fields": [      {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "type": "text",        "required": true,        "position": 0,        "options": {}      }    ]  },  "node": {    "id": "string",    "parentId": "string",    "type": "folder",    "slug": "string",    "name": "string",    "description": "string",    "metadata": {},    "settings": {},    "explicitVisibility": null,    "icon": null,    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "baseId": "string",    "children": [      {        "id": "string",        "parentId": "string",        "type": "folder",        "slug": "string",        "name": "string",        "description": "string",        "metadata": {},        "settings": {},        "explicitVisibility": null,        "icon": null,        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "baseId": "string",        "children": [          null        ],        "hasChildren": true,        "shared": true      }    ],    "hasChildren": true,    "shared": true  },  "operations": [    {      "id": "string",      "changeRequestId": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operation": "node_create",      "status": "pending",      "targetRecordId": "string",      "targetViewId": "string",      "filePath": "string",      "sourceRecordId": "string",      "sourceCommitId": "string",      "baseCommitId": "string",      "headCommitId": "string",      "deleteMode": "archive",      "mergedRecordId": "string",      "mergedViewId": "string",      "position": 0,      "createdAt": "string",      "updatedAt": "string",      "headCommit": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operationId": "string",        "parentCommitId": "string",        "payload": {          "property1": null,          "property2": null        },        "operation": "node_create",        "message": "string",        "author": "string",        "authorUser": null,        "createdAt": "string"      },      "baseFields": {        "property1": null,        "property2": null      }    }  ],  "primaryOperation": {    "id": "string",    "changeRequestId": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "operation": "node_create",    "status": "pending",    "targetRecordId": "string",    "targetViewId": "string",    "filePath": "string",    "sourceRecordId": "string",    "sourceCommitId": "string",    "baseCommitId": "string",    "headCommitId": "string",    "deleteMode": "archive",    "mergedRecordId": "string",    "mergedViewId": "string",    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "headCommit": {      "id": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operationId": "string",      "parentCommitId": "string",      "payload": {        "property1": null,        "property2": null      },      "operation": "node_create",      "message": "string",      "author": "string",      "authorUser": null,      "createdAt": "string"    },    "baseFields": {      "property1": null,      "property2": null    }  },  "operationCount": 0,  "reviews": [    {      "id": "string",      "changeRequestId": "string",      "reviewerId": "string",      "reviewer": null,      "verdict": "approved",      "reason": "string",      "visibleOperationHeads": {        "property1": "string",        "property2": "string"      },      "createdAt": "string"    }  ]}

Create Base lifecycle change request

Path Parameters

baseId*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

message?string

submittedBy?string

Default"local-editor"

autoMerge?|boolean

operation*unknown|unknown

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/bases/string/lifecycle/change-requests" \  -H "Content-Type: application/json" \  -d '{    "operation": "archive"  }'

{  "id": "string",  "baseId": "string",  "targetType": "base",  "nodeId": "string",  "status": "in_review",  "submittedBy": "string",  "submittedByUser": null,  "sourceAttribution": {    "displayName": "string",    "ownerName": "string",    "channel": "web_ui"  },  "sourceMeta": {    "property1": null,    "property2": null  },  "reviewPolicySnapshot": {    "property1": null,    "property2": null  },  "mergeSummary": {    "property1": null,    "property2": null  },  "rejectedReason": "string",  "reviewedAt": "string",  "mergedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "base": {    "id": "string",    "nodeId": "string",    "slug": "string",    "name": "string",    "description": "string",    "reviewPolicy": {      "kind": "single",      "requiredApprovals": 0    },    "createdAt": "string",    "fields": [      {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "type": "text",        "required": true,        "position": 0,        "options": {}      }    ]  },  "node": {    "id": "string",    "parentId": "string",    "type": "folder",    "slug": "string",    "name": "string",    "description": "string",    "metadata": {},    "settings": {},    "explicitVisibility": null,    "icon": null,    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "baseId": "string",    "children": [      {        "id": "string",        "parentId": "string",        "type": "folder",        "slug": "string",        "name": "string",        "description": "string",        "metadata": {},        "settings": {},        "explicitVisibility": null,        "icon": null,        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "baseId": "string",        "children": [          null        ],        "hasChildren": true,        "shared": true      }    ],    "hasChildren": true,    "shared": true  },  "operations": [    {      "id": "string",      "changeRequestId": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operation": "node_create",      "status": "pending",      "targetRecordId": "string",      "targetViewId": "string",      "filePath": "string",      "sourceRecordId": "string",      "sourceCommitId": "string",      "baseCommitId": "string",      "headCommitId": "string",      "deleteMode": "archive",      "mergedRecordId": "string",      "mergedViewId": "string",      "position": 0,      "createdAt": "string",      "updatedAt": "string",      "headCommit": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operationId": "string",        "parentCommitId": "string",        "payload": {          "property1": null,          "property2": null        },        "operation": "node_create",        "message": "string",        "author": "string",        "authorUser": null,        "createdAt": "string"      },      "baseFields": {        "property1": null,        "property2": null      }    }  ],  "primaryOperation": {    "id": "string",    "changeRequestId": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "operation": "node_create",    "status": "pending",    "targetRecordId": "string",    "targetViewId": "string",    "filePath": "string",    "sourceRecordId": "string",    "sourceCommitId": "string",    "baseCommitId": "string",    "headCommitId": "string",    "deleteMode": "archive",    "mergedRecordId": "string",    "mergedViewId": "string",    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "headCommit": {      "id": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operationId": "string",      "parentCommitId": "string",      "payload": {        "property1": null,        "property2": null      },      "operation": "node_create",      "message": "string",      "author": "string",      "authorUser": null,      "createdAt": "string"    },    "baseFields": {      "property1": null,      "property2": null    }  },  "operationCount": 0,  "reviews": [    {      "id": "string",      "changeRequestId": "string",      "reviewerId": "string",      "reviewer": null,      "verdict": "approved",      "reason": "string",      "visibleOperationHeads": {        "property1": "string",        "property2": "string"      },      "createdAt": "string"    }  ]}

Create file-tree change request

Path Parameters

nodeId*string

A node id OR a slug. A slug is only unique WITHIN a type, so pass type alongside one; a node id needs no hint.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

message?string

Explanation shown to the human reviewer. Write a conventional-commit style subject — imperative verb + what + why, e.g. "Rewrite README.md quickstart for the new auth flow".

Default"Update file tree"

submittedBy?string

Default"local-producer"

operations*array<|||>

Items1 <= items

autoMerge?boolean

Whether to approve and merge these file changes immediately. Omitted defaults to merging immediately if the actor has write access on the node, otherwise falling back to a pending Change Request; pass explicit false to force review even with write access. Applies to every operation kind, deletes included.

type?string

Disambiguates a slug. Unnecessary — and ignored — when nodeId is an id.

Value in

"skill"
"drive"
"airapp"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/file-trees/string/change-requests" \  -H "Content-Type: application/json" \  -d '{    "operations": [      {        "kind": "create",        "path": "string",        "assetId": "string"      }    ]  }'

{  "id": "string",  "baseId": "string",  "targetType": "base",  "nodeId": "string",  "status": "in_review",  "submittedBy": "string",  "submittedByUser": null,  "sourceAttribution": {    "displayName": "string",    "ownerName": "string",    "channel": "web_ui"  },  "sourceMeta": {    "property1": null,    "property2": null  },  "reviewPolicySnapshot": {    "property1": null,    "property2": null  },  "mergeSummary": {    "property1": null,    "property2": null  },  "rejectedReason": "string",  "reviewedAt": "string",  "mergedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "base": {    "id": "string",    "nodeId": "string",    "slug": "string",    "name": "string",    "description": "string",    "reviewPolicy": {      "kind": "single",      "requiredApprovals": 0    },    "createdAt": "string",    "fields": [      {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "type": "text",        "required": true,        "position": 0,        "options": {}      }    ]  },  "node": {    "id": "string",    "parentId": "string",    "type": "folder",    "slug": "string",    "name": "string",    "description": "string",    "metadata": {},    "settings": {},    "explicitVisibility": null,    "icon": null,    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "baseId": "string",    "children": [      {        "id": "string",        "parentId": "string",        "type": "folder",        "slug": "string",        "name": "string",        "description": "string",        "metadata": {},        "settings": {},        "explicitVisibility": null,        "icon": null,        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "baseId": "string",        "children": [          null        ],        "hasChildren": true,        "shared": true      }    ],    "hasChildren": true,    "shared": true  },  "operations": [    {      "id": "string",      "changeRequestId": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operation": "node_create",      "status": "pending",      "targetRecordId": "string",      "targetViewId": "string",      "filePath": "string",      "sourceRecordId": "string",      "sourceCommitId": "string",      "baseCommitId": "string",      "headCommitId": "string",      "deleteMode": "archive",      "mergedRecordId": "string",      "mergedViewId": "string",      "position": 0,      "createdAt": "string",      "updatedAt": "string",      "headCommit": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operationId": "string",        "parentCommitId": "string",        "payload": {          "property1": null,          "property2": null        },        "operation": "node_create",        "message": "string",        "author": "string",        "authorUser": null,        "createdAt": "string"      },      "baseFields": {        "property1": null,        "property2": null      }    }  ],  "primaryOperation": {    "id": "string",    "changeRequestId": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "operation": "node_create",    "status": "pending",    "targetRecordId": "string",    "targetViewId": "string",    "filePath": "string",    "sourceRecordId": "string",    "sourceCommitId": "string",    "baseCommitId": "string",    "headCommitId": "string",    "deleteMode": "archive",    "mergedRecordId": "string",    "mergedViewId": "string",    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "headCommit": {      "id": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operationId": "string",      "parentCommitId": "string",      "payload": {        "property1": null,        "property2": null      },      "operation": "node_create",      "message": "string",      "author": "string",      "authorUser": null,      "createdAt": "string"    },    "baseFields": {      "property1": null,      "property2": null    }  },  "operationCount": 0,  "reviews": [    {      "id": "string",      "changeRequestId": "string",      "reviewerId": "string",      "reviewer": null,      "verdict": "approved",      "reason": "string",      "visibleOperationHeads": {        "property1": "string",        "property2": "string"      },      "createdAt": "string"    }  ]}

Edit an asset's file content via string-replace edits, as a ChangeRequest

Path Parameters

assetId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

edits*array<>

Items1 <= items

message?string

Explanation shown to the human reviewer. Write a conventional-commit style subject — imperative verb + what + why, e.g. "Fix typo in setup instructions".

Default"Edit file content"

submittedBy?string

Default"agent"

autoMerge?boolean

Whether to approve and merge this change immediately. Omitted defaults to merging immediately if the actor has write access on the target node, otherwise falling back to a pending Change Request; pass explicit false to force review even with write access. This rewrites the real mounted file bytes; the previous content stays in the Change Request history, so it is recoverable but not one-click undoable.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/assets/string/edit-content" \  -H "Content-Type: application/json" \  -d '{    "edits": [      {        "oldString": "string",        "newString": "string"      }    ]  }'

{  "id": "string",  "baseId": "string",  "targetType": "base",  "nodeId": "string",  "status": "in_review",  "submittedBy": "string",  "submittedByUser": null,  "sourceAttribution": {    "displayName": "string",    "ownerName": "string",    "channel": "web_ui"  },  "sourceMeta": {    "property1": null,    "property2": null  },  "reviewPolicySnapshot": {    "property1": null,    "property2": null  },  "mergeSummary": {    "property1": null,    "property2": null  },  "rejectedReason": "string",  "reviewedAt": "string",  "mergedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "base": {    "id": "string",    "nodeId": "string",    "slug": "string",    "name": "string",    "description": "string",    "reviewPolicy": {      "kind": "single",      "requiredApprovals": 0    },    "createdAt": "string",    "fields": [      {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "type": "text",        "required": true,        "position": 0,        "options": {}      }    ]  },  "node": {    "id": "string",    "parentId": "string",    "type": "folder",    "slug": "string",    "name": "string",    "description": "string",    "metadata": {},    "settings": {},    "explicitVisibility": null,    "icon": null,    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "baseId": "string",    "children": [      {        "id": "string",        "parentId": "string",        "type": "folder",        "slug": "string",        "name": "string",        "description": "string",        "metadata": {},        "settings": {},        "explicitVisibility": null,        "icon": null,        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "baseId": "string",        "children": [          null        ],        "hasChildren": true,        "shared": true      }    ],    "hasChildren": true,    "shared": true  },  "operations": [    {      "id": "string",      "changeRequestId": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operation": "node_create",      "status": "pending",      "targetRecordId": "string",      "targetViewId": "string",      "filePath": "string",      "sourceRecordId": "string",      "sourceCommitId": "string",      "baseCommitId": "string",      "headCommitId": "string",      "deleteMode": "archive",      "mergedRecordId": "string",      "mergedViewId": "string",      "position": 0,      "createdAt": "string",      "updatedAt": "string",      "headCommit": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operationId": "string",        "parentCommitId": "string",        "payload": {          "property1": null,          "property2": null        },        "operation": "node_create",        "message": "string",        "author": "string",        "authorUser": null,        "createdAt": "string"      },      "baseFields": {        "property1": null,        "property2": null      }    }  ],  "primaryOperation": {    "id": "string",    "changeRequestId": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "operation": "node_create",    "status": "pending",    "targetRecordId": "string",    "targetViewId": "string",    "filePath": "string",    "sourceRecordId": "string",    "sourceCommitId": "string",    "baseCommitId": "string",    "headCommitId": "string",    "deleteMode": "archive",    "mergedRecordId": "string",    "mergedViewId": "string",    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "headCommit": {      "id": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operationId": "string",      "parentCommitId": "string",      "payload": {        "property1": null,        "property2": null      },      "operation": "node_create",      "message": "string",      "author": "string",      "authorUser": null,      "createdAt": "string"    },    "baseFields": {      "property1": null,      "property2": null    }  },  "operationCount": 0,  "reviews": [    {      "id": "string",      "changeRequestId": "string",      "reviewerId": "string",      "reviewer": null,      "verdict": "approved",      "reason": "string",      "visibleOperationHeads": {        "property1": "string",        "property2": "string"      },      "createdAt": "string"    }  ]}

List change requests

Query Parameters

limit?integer

Change requests per page. Capped at 100; ask for the next page with cursor.

Range1 <= value <= 100

Default50

cursor?string

Opaque page cursor: pass back the nextCursor from the previous response. Do not construct or parse it.

status?array<>

Keep only these statuses. Omitting it returns every status, not just open ones.

mine?boolean

Only change requests CREATED by the acting user — not ones awaiting their review.

affectsNodeId?string

Only change requests whose target, or any of their operations, touches this node — including Base-backed nodes. To ask whether a resource already has an unfinished change request, pass this with limit: 1 rather than paging the space: an empty result is conclusive.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/change-requests"

{  "changeRequests": [    {      "id": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "status": "in_review",      "submittedBy": "string",      "submittedByUser": null,      "sourceAttribution": {        "displayName": "string",        "ownerName": "string",        "channel": "web_ui"      },      "sourceMeta": {        "property1": null,        "property2": null      },      "reviewPolicySnapshot": {        "property1": null,        "property2": null      },      "mergeSummary": {        "property1": null,        "property2": null      },      "rejectedReason": "string",      "reviewedAt": "string",      "mergedAt": "string",      "createdAt": "string",      "updatedAt": "string",      "base": {        "id": "string",        "nodeId": "string",        "slug": "string",        "name": "string",        "description": "string",        "reviewPolicy": {          "kind": "single",          "requiredApprovals": 0        },        "createdAt": "string",        "fields": [          {            "id": "string",            "baseId": "string",            "slug": "string",            "name": "string",            "type": "text",            "required": true,            "position": 0,            "options": {}          }        ]      },      "node": {        "id": "string",        "parentId": "string",        "type": "folder",        "slug": "string",        "name": "string",        "description": "string",        "metadata": {},        "settings": {},        "explicitVisibility": null,        "icon": null,        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "baseId": "string",        "children": [          {            "id": "string",            "parentId": "string",            "type": "folder",            "slug": "string",            "name": "string",            "description": "string",            "metadata": {},            "settings": {},            "explicitVisibility": null,            "icon": null,            "position": 0,            "createdAt": "string",            "updatedAt": "string",            "baseId": "string",            "children": [              null            ],            "hasChildren": true,            "shared": true          }        ],        "hasChildren": true,        "shared": true      },      "operations": [        {          "id": "string",          "changeRequestId": "string",          "baseId": "string",          "targetType": "base",          "nodeId": "string",          "operation": "node_create",          "status": "pending",          "targetRecordId": "string",          "targetViewId": "string",          "filePath": "string",          "sourceRecordId": "string",          "sourceCommitId": "string",          "baseCommitId": "string",          "headCommitId": "string",          "deleteMode": "archive",          "mergedRecordId": "string",          "mergedViewId": "string",          "position": 0,          "createdAt": "string",          "updatedAt": "string",          "headCommit": {            "id": "string",            "baseId": "string",            "targetType": "base",            "nodeId": "string",            "operationId": "string",            "parentCommitId": "string",            "payload": {              "property1": null,              "property2": null            },            "operation": "node_create",            "message": "string",            "author": "string",            "authorUser": null,            "createdAt": "string"          },          "baseFields": {            "property1": null,            "property2": null          }        }      ],      "primaryOperation": {        "id": "string",        "changeRequestId": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operation": "node_create",        "status": "pending",        "targetRecordId": "string",        "targetViewId": "string",        "filePath": "string",        "sourceRecordId": "string",        "sourceCommitId": "string",        "baseCommitId": "string",        "headCommitId": "string",        "deleteMode": "archive",        "mergedRecordId": "string",        "mergedViewId": "string",        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "headCommit": {          "id": "string",          "baseId": "string",          "targetType": "base",          "nodeId": "string",          "operationId": "string",          "parentCommitId": "string",          "payload": {            "property1": null,            "property2": null          },          "operation": "node_create",          "message": "string",          "author": "string",          "authorUser": null,          "createdAt": "string"        },        "baseFields": {          "property1": null,          "property2": null        }      },      "operationCount": 0,      "reviews": [        {          "id": "string",          "changeRequestId": "string",          "reviewerId": "string",          "reviewer": null,          "verdict": "approved",          "reason": "string",          "visibleOperationHeads": {            "property1": "string",            "property2": "string"          },          "createdAt": "string"        }      ]    }  ],  "nextCursor": "string"}

List a numbered change request page

Query Parameters

page?integer

1-indexed, not 0-indexed.

Range1 <= value <= 9007199254740991

Default1

pageSize?integer

Change requests per page. Capped at 100.

Range1 <= value <= 100

Default50

status?array<>

Keep only these statuses. Omitting it returns every status, not just open ones.

mine?boolean

Only change requests CREATED by the acting user — not ones awaiting their review.

affectsNodeId?string

Only change requests whose target, or any of their operations, touches this node — including Base-backed nodes.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/change-requests/page"

{  "changeRequests": [    {      "id": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "status": "in_review",      "submittedBy": "string",      "submittedByUser": null,      "sourceAttribution": {        "displayName": "string",        "ownerName": "string",        "channel": "web_ui"      },      "sourceMeta": {        "property1": null,        "property2": null      },      "reviewPolicySnapshot": {        "property1": null,        "property2": null      },      "mergeSummary": {        "property1": null,        "property2": null      },      "rejectedReason": "string",      "reviewedAt": "string",      "mergedAt": "string",      "createdAt": "string",      "updatedAt": "string",      "base": {        "id": "string",        "nodeId": "string",        "slug": "string",        "name": "string",        "description": "string",        "reviewPolicy": {          "kind": "single",          "requiredApprovals": 0        },        "createdAt": "string",        "fields": [          {            "id": "string",            "baseId": "string",            "slug": "string",            "name": "string",            "type": "text",            "required": true,            "position": 0,            "options": {}          }        ]      },      "node": {        "id": "string",        "parentId": "string",        "type": "folder",        "slug": "string",        "name": "string",        "description": "string",        "metadata": {},        "settings": {},        "explicitVisibility": null,        "icon": null,        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "baseId": "string",        "children": [          {            "id": "string",            "parentId": "string",            "type": "folder",            "slug": "string",            "name": "string",            "description": "string",            "metadata": {},            "settings": {},            "explicitVisibility": null,            "icon": null,            "position": 0,            "createdAt": "string",            "updatedAt": "string",            "baseId": "string",            "children": [              null            ],            "hasChildren": true,            "shared": true          }        ],        "hasChildren": true,        "shared": true      },      "operations": [        {          "id": "string",          "changeRequestId": "string",          "baseId": "string",          "targetType": "base",          "nodeId": "string",          "operation": "node_create",          "status": "pending",          "targetRecordId": "string",          "targetViewId": "string",          "filePath": "string",          "sourceRecordId": "string",          "sourceCommitId": "string",          "baseCommitId": "string",          "headCommitId": "string",          "deleteMode": "archive",          "mergedRecordId": "string",          "mergedViewId": "string",          "position": 0,          "createdAt": "string",          "updatedAt": "string",          "headCommit": {            "id": "string",            "baseId": "string",            "targetType": "base",            "nodeId": "string",            "operationId": "string",            "parentCommitId": "string",            "payload": {              "property1": null,              "property2": null            },            "operation": "node_create",            "message": "string",            "author": "string",            "authorUser": null,            "createdAt": "string"          },          "baseFields": {            "property1": null,            "property2": null          }        }      ],      "primaryOperation": {        "id": "string",        "changeRequestId": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operation": "node_create",        "status": "pending",        "targetRecordId": "string",        "targetViewId": "string",        "filePath": "string",        "sourceRecordId": "string",        "sourceCommitId": "string",        "baseCommitId": "string",        "headCommitId": "string",        "deleteMode": "archive",        "mergedRecordId": "string",        "mergedViewId": "string",        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "headCommit": {          "id": "string",          "baseId": "string",          "targetType": "base",          "nodeId": "string",          "operationId": "string",          "parentCommitId": "string",          "payload": {            "property1": null,            "property2": null          },          "operation": "node_create",          "message": "string",          "author": "string",          "authorUser": null,          "createdAt": "string"        },        "baseFields": {          "property1": null,          "property2": null        }      },      "operationCount": 0,      "reviews": [        {          "id": "string",          "changeRequestId": "string",          "reviewerId": "string",          "reviewer": null,          "verdict": "approved",          "reason": "string",          "visibleOperationHeads": {            "property1": "string",            "property2": "string"          },          "createdAt": "string"        }      ]    }  ],  "total": 0,  "totalPages": 0,  "page": 1,  "pageSize": 1}

Count change requests by inbox tab

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/change-requests/counts"

{  "review": 0,  "changes": 0,  "created": 0,  "approved": 0,  "merged": 0,  "rejected": 0}

Get change request

Path Parameters

changeRequestId*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/change-requests/string"

{  "id": "string",  "baseId": "string",  "targetType": "base",  "nodeId": "string",  "status": "in_review",  "submittedBy": "string",  "submittedByUser": null,  "sourceAttribution": {    "displayName": "string",    "ownerName": "string",    "channel": "web_ui"  },  "sourceMeta": {    "property1": null,    "property2": null  },  "reviewPolicySnapshot": {    "property1": null,    "property2": null  },  "mergeSummary": {    "property1": null,    "property2": null  },  "rejectedReason": "string",  "reviewedAt": "string",  "mergedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "base": {    "id": "string",    "nodeId": "string",    "slug": "string",    "name": "string",    "description": "string",    "reviewPolicy": {      "kind": "single",      "requiredApprovals": 0    },    "createdAt": "string",    "fields": [      {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "type": "text",        "required": true,        "position": 0,        "options": {}      }    ]  },  "node": {    "id": "string",    "parentId": "string",    "type": "folder",    "slug": "string",    "name": "string",    "description": "string",    "metadata": {},    "settings": {},    "explicitVisibility": null,    "icon": null,    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "baseId": "string",    "children": [      {        "id": "string",        "parentId": "string",        "type": "folder",        "slug": "string",        "name": "string",        "description": "string",        "metadata": {},        "settings": {},        "explicitVisibility": null,        "icon": null,        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "baseId": "string",        "children": [          null        ],        "hasChildren": true,        "shared": true      }    ],    "hasChildren": true,    "shared": true  },  "operations": [    {      "id": "string",      "changeRequestId": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operation": "node_create",      "status": "pending",      "targetRecordId": "string",      "targetViewId": "string",      "filePath": "string",      "sourceRecordId": "string",      "sourceCommitId": "string",      "baseCommitId": "string",      "headCommitId": "string",      "deleteMode": "archive",      "mergedRecordId": "string",      "mergedViewId": "string",      "position": 0,      "createdAt": "string",      "updatedAt": "string",      "headCommit": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operationId": "string",        "parentCommitId": "string",        "payload": {          "property1": null,          "property2": null        },        "operation": "node_create",        "message": "string",        "author": "string",        "authorUser": null,        "createdAt": "string"      },      "baseFields": {        "property1": null,        "property2": null      }    }  ],  "primaryOperation": {    "id": "string",    "changeRequestId": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "operation": "node_create",    "status": "pending",    "targetRecordId": "string",    "targetViewId": "string",    "filePath": "string",    "sourceRecordId": "string",    "sourceCommitId": "string",    "baseCommitId": "string",    "headCommitId": "string",    "deleteMode": "archive",    "mergedRecordId": "string",    "mergedViewId": "string",    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "headCommit": {      "id": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operationId": "string",      "parentCommitId": "string",      "payload": {        "property1": null,        "property2": null      },      "operation": "node_create",      "message": "string",      "author": "string",      "authorUser": null,      "createdAt": "string"    },    "baseFields": {      "property1": null,      "property2": null    }  },  "operationCount": 0,  "reviews": [    {      "id": "string",      "changeRequestId": "string",      "reviewerId": "string",      "reviewer": null,      "verdict": "approved",      "reason": "string",      "visibleOperationHeads": {        "property1": "string",        "property2": "string"      },      "createdAt": "string"    }  ]}

Review change requests

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

verdict*string

Value in

"approved"
"rejected"

reason?string

changeRequestIds*array<string>

Items1 <= items <= 100

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/change-requests/reviews" \  -H "Content-Type: application/json" \  -d '{    "verdict": "approved",    "changeRequestIds": [      "string"    ]  }'

{  "results": [    {      "changeRequestId": "string",      "ok": true,      "status": "string",      "changeRequest": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "status": "in_review",        "submittedBy": "string",        "submittedByUser": null,        "sourceAttribution": {          "displayName": "string",          "ownerName": "string",          "channel": "web_ui"        },        "sourceMeta": {          "property1": null,          "property2": null        },        "reviewPolicySnapshot": {          "property1": null,          "property2": null        },        "mergeSummary": {          "property1": null,          "property2": null        },        "rejectedReason": "string",        "reviewedAt": "string",        "mergedAt": "string",        "createdAt": "string",        "updatedAt": "string",        "base": {          "id": "string",          "nodeId": "string",          "slug": "string",          "name": "string",          "description": "string",          "reviewPolicy": {            "kind": "single",            "requiredApprovals": 0          },          "createdAt": "string",          "fields": [            {              "id": "string",              "baseId": "string",              "slug": "string",              "name": "string",              "type": "text",              "required": true,              "position": 0,              "options": {}            }          ]        },        "node": {          "id": "string",          "parentId": "string",          "type": "folder",          "slug": "string",          "name": "string",          "description": "string",          "metadata": {},          "settings": {},          "explicitVisibility": null,          "icon": null,          "position": 0,          "createdAt": "string",          "updatedAt": "string",          "baseId": "string",          "children": [            {              "id": "string",              "parentId": "string",              "type": "folder",              "slug": "string",              "name": "string",              "description": "string",              "metadata": {},              "settings": {},              "explicitVisibility": null,              "icon": null,              "position": 0,              "createdAt": "string",              "updatedAt": "string",              "baseId": "string",              "children": [                null              ],              "hasChildren": true,              "shared": true            }          ],          "hasChildren": true,          "shared": true        },        "operations": [          {            "id": "string",            "changeRequestId": "string",            "baseId": "string",            "targetType": "base",            "nodeId": "string",            "operation": "node_create",            "status": "pending",            "targetRecordId": "string",            "targetViewId": "string",            "filePath": "string",            "sourceRecordId": "string",            "sourceCommitId": "string",            "baseCommitId": "string",            "headCommitId": "string",            "deleteMode": "archive",            "mergedRecordId": "string",            "mergedViewId": "string",            "position": 0,            "createdAt": "string",            "updatedAt": "string",            "headCommit": {              "id": "string",              "baseId": "string",              "targetType": "base",              "nodeId": "string",              "operationId": "string",              "parentCommitId": "string",              "payload": {                "property1": null,                "property2": null              },              "operation": "node_create",              "message": "string",              "author": "string",              "authorUser": null,              "createdAt": "string"            },            "baseFields": {              "property1": null,              "property2": null            }          }        ],        "primaryOperation": {          "id": "string",          "changeRequestId": "string",          "baseId": "string",          "targetType": "base",          "nodeId": "string",          "operation": "node_create",          "status": "pending",          "targetRecordId": "string",          "targetViewId": "string",          "filePath": "string",          "sourceRecordId": "string",          "sourceCommitId": "string",          "baseCommitId": "string",          "headCommitId": "string",          "deleteMode": "archive",          "mergedRecordId": "string",          "mergedViewId": "string",          "position": 0,          "createdAt": "string",          "updatedAt": "string",          "headCommit": {            "id": "string",            "baseId": "string",            "targetType": "base",            "nodeId": "string",            "operationId": "string",            "parentCommitId": "string",            "payload": {              "property1": null,              "property2": null            },            "operation": "node_create",            "message": "string",            "author": "string",            "authorUser": null,            "createdAt": "string"          },          "baseFields": {            "property1": null,            "property2": null          }        },        "operationCount": 0,        "reviews": [          {            "id": "string",            "changeRequestId": "string",            "reviewerId": "string",            "reviewer": null,            "verdict": "approved",            "reason": "string",            "visibleOperationHeads": {              "property1": "string",              "property2": "string"            },            "createdAt": "string"          }        ]      }    }  ]}

Close change request

Path Parameters

changeRequestId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason?string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/change-requests/string/close" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "baseId": "string",  "targetType": "base",  "nodeId": "string",  "status": "in_review",  "submittedBy": "string",  "submittedByUser": null,  "sourceAttribution": {    "displayName": "string",    "ownerName": "string",    "channel": "web_ui"  },  "sourceMeta": {    "property1": null,    "property2": null  },  "reviewPolicySnapshot": {    "property1": null,    "property2": null  },  "mergeSummary": {    "property1": null,    "property2": null  },  "rejectedReason": "string",  "reviewedAt": "string",  "mergedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "base": {    "id": "string",    "nodeId": "string",    "slug": "string",    "name": "string",    "description": "string",    "reviewPolicy": {      "kind": "single",      "requiredApprovals": 0    },    "createdAt": "string",    "fields": [      {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "type": "text",        "required": true,        "position": 0,        "options": {}      }    ]  },  "node": {    "id": "string",    "parentId": "string",    "type": "folder",    "slug": "string",    "name": "string",    "description": "string",    "metadata": {},    "settings": {},    "explicitVisibility": null,    "icon": null,    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "baseId": "string",    "children": [      {        "id": "string",        "parentId": "string",        "type": "folder",        "slug": "string",        "name": "string",        "description": "string",        "metadata": {},        "settings": {},        "explicitVisibility": null,        "icon": null,        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "baseId": "string",        "children": [          null        ],        "hasChildren": true,        "shared": true      }    ],    "hasChildren": true,    "shared": true  },  "operations": [    {      "id": "string",      "changeRequestId": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operation": "node_create",      "status": "pending",      "targetRecordId": "string",      "targetViewId": "string",      "filePath": "string",      "sourceRecordId": "string",      "sourceCommitId": "string",      "baseCommitId": "string",      "headCommitId": "string",      "deleteMode": "archive",      "mergedRecordId": "string",      "mergedViewId": "string",      "position": 0,      "createdAt": "string",      "updatedAt": "string",      "headCommit": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operationId": "string",        "parentCommitId": "string",        "payload": {          "property1": null,          "property2": null        },        "operation": "node_create",        "message": "string",        "author": "string",        "authorUser": null,        "createdAt": "string"      },      "baseFields": {        "property1": null,        "property2": null      }    }  ],  "primaryOperation": {    "id": "string",    "changeRequestId": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "operation": "node_create",    "status": "pending",    "targetRecordId": "string",    "targetViewId": "string",    "filePath": "string",    "sourceRecordId": "string",    "sourceCommitId": "string",    "baseCommitId": "string",    "headCommitId": "string",    "deleteMode": "archive",    "mergedRecordId": "string",    "mergedViewId": "string",    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "headCommit": {      "id": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operationId": "string",      "parentCommitId": "string",      "payload": {        "property1": null,        "property2": null      },      "operation": "node_create",      "message": "string",      "author": "string",      "authorUser": null,      "createdAt": "string"    },    "baseFields": {      "property1": null,      "property2": null    }  },  "operationCount": 0,  "reviews": [    {      "id": "string",      "changeRequestId": "string",      "reviewerId": "string",      "reviewer": null,      "verdict": "approved",      "reason": "string",      "visibleOperationHeads": {        "property1": "string",        "property2": "string"      },      "createdAt": "string"    }  ]}

Merge change requests

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

changeRequestIds*array<string>

Items1 <= items <= 100

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/change-requests/merge" \  -H "Content-Type: application/json" \  -d '{    "changeRequestIds": [      "string"    ]  }'

{  "results": [    {      "changeRequestId": "string",      "ok": true,      "status": "string",      "changeRequest": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "status": "in_review",        "submittedBy": "string",        "submittedByUser": null,        "sourceAttribution": {          "displayName": "string",          "ownerName": "string",          "channel": "web_ui"        },        "sourceMeta": {          "property1": null,          "property2": null        },        "reviewPolicySnapshot": {          "property1": null,          "property2": null        },        "mergeSummary": {          "property1": null,          "property2": null        },        "rejectedReason": "string",        "reviewedAt": "string",        "mergedAt": "string",        "createdAt": "string",        "updatedAt": "string",        "base": {          "id": "string",          "nodeId": "string",          "slug": "string",          "name": "string",          "description": "string",          "reviewPolicy": {            "kind": "single",            "requiredApprovals": 0          },          "createdAt": "string",          "fields": [            {              "id": "string",              "baseId": "string",              "slug": "string",              "name": "string",              "type": "text",              "required": true,              "position": 0,              "options": {}            }          ]        },        "node": {          "id": "string",          "parentId": "string",          "type": "folder",          "slug": "string",          "name": "string",          "description": "string",          "metadata": {},          "settings": {},          "explicitVisibility": null,          "icon": null,          "position": 0,          "createdAt": "string",          "updatedAt": "string",          "baseId": "string",          "children": [            {              "id": "string",              "parentId": "string",              "type": "folder",              "slug": "string",              "name": "string",              "description": "string",              "metadata": {},              "settings": {},              "explicitVisibility": null,              "icon": null,              "position": 0,              "createdAt": "string",              "updatedAt": "string",              "baseId": "string",              "children": [                null              ],              "hasChildren": true,              "shared": true            }          ],          "hasChildren": true,          "shared": true        },        "operations": [          {            "id": "string",            "changeRequestId": "string",            "baseId": "string",            "targetType": "base",            "nodeId": "string",            "operation": "node_create",            "status": "pending",            "targetRecordId": "string",            "targetViewId": "string",            "filePath": "string",            "sourceRecordId": "string",            "sourceCommitId": "string",            "baseCommitId": "string",            "headCommitId": "string",            "deleteMode": "archive",            "mergedRecordId": "string",            "mergedViewId": "string",            "position": 0,            "createdAt": "string",            "updatedAt": "string",            "headCommit": {              "id": "string",              "baseId": "string",              "targetType": "base",              "nodeId": "string",              "operationId": "string",              "parentCommitId": "string",              "payload": {                "property1": null,                "property2": null              },              "operation": "node_create",              "message": "string",              "author": "string",              "authorUser": null,              "createdAt": "string"            },            "baseFields": {              "property1": null,              "property2": null            }          }        ],        "primaryOperation": {          "id": "string",          "changeRequestId": "string",          "baseId": "string",          "targetType": "base",          "nodeId": "string",          "operation": "node_create",          "status": "pending",          "targetRecordId": "string",          "targetViewId": "string",          "filePath": "string",          "sourceRecordId": "string",          "sourceCommitId": "string",          "baseCommitId": "string",          "headCommitId": "string",          "deleteMode": "archive",          "mergedRecordId": "string",          "mergedViewId": "string",          "position": 0,          "createdAt": "string",          "updatedAt": "string",          "headCommit": {            "id": "string",            "baseId": "string",            "targetType": "base",            "nodeId": "string",            "operationId": "string",            "parentCommitId": "string",            "payload": {              "property1": null,              "property2": null            },            "operation": "node_create",            "message": "string",            "author": "string",            "authorUser": null,            "createdAt": "string"          },          "baseFields": {            "property1": null,            "property2": null          }        },        "operationCount": 0,        "reviews": [          {            "id": "string",            "changeRequestId": "string",            "reviewerId": "string",            "reviewer": null,            "verdict": "approved",            "reason": "string",            "visibleOperationHeads": {              "property1": "string",              "property2": "string"            },            "createdAt": "string"          }        ]      },      "record": {        "id": "string",        "baseId": "string",        "headCommitId": "string",        "parentRecordId": "string",        "parentCommitId": "string",        "status": "active",        "createdBy": "string",        "createdByUser": null,        "fieldUsers": {},        "archivedAt": "string",        "createdAt": "string",        "updatedAt": "string",        "base": {          "id": "string",          "nodeId": "string",          "slug": "string",          "name": "string",          "description": "string",          "reviewPolicy": {            "kind": "single",            "requiredApprovals": 0          },          "createdAt": "string",          "fields": [            {              "id": "string",              "baseId": "string",              "slug": "string",              "name": "string",              "type": "text",              "required": true,              "position": 0,              "options": {}            }          ]        },        "headCommit": {          "id": "string",          "baseId": "string",          "targetType": "base",          "nodeId": "string",          "operationId": "string",          "parentCommitId": "string",          "payload": {            "property1": null,            "property2": null          },          "operation": "node_create",          "message": "string",          "author": "string",          "authorUser": null,          "createdAt": "string"        }      },      "view": {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "description": "string",        "type": "table",        "config": {          "filters": [],          "sorts": [],          "visibleFieldSlugs": [            "string"          ],          "fieldWidths": {            "property1": 92,            "property2": 92          },          "coverFieldSlug": "string",          "coverFit": "cover",          "cardSize": "small",          "showFieldLabels": true,          "stackByFieldSlug": "string",          "dateFieldSlug": "string",          "startFieldSlug": "string",          "endFieldSlug": "string",          "ganttScale": "week"        },        "status": "active",        "createdBy": "string",        "createdByUser": null,        "archivedAt": "string",        "createdAt": "string",        "updatedAt": "string"      }    }  ]}

Revise operation

Path Parameters

operationId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fields*

Updated field values keyed by field slug. If you set the base's PRIMARY field (its first field), keep it a short human-readable name — it is the record's display title everywhere.

message?string

Explanation shown to the human reviewer. Write a conventional-commit style subject — imperative verb + what + why, e.g. "Update deal stage to qualified — demo booked for July 8".

Default"Revise operation"

author?string

Default"local-producer"

baseCommitId?string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/operations/string/revisions" \  -H "Content-Type: application/json" \  -d '{    "fields": {      "property1": null,      "property2": null    }  }'

{  "id": "string",  "baseId": "string",  "targetType": "base",  "nodeId": "string",  "status": "in_review",  "submittedBy": "string",  "submittedByUser": null,  "sourceAttribution": {    "displayName": "string",    "ownerName": "string",    "channel": "web_ui"  },  "sourceMeta": {    "property1": null,    "property2": null  },  "reviewPolicySnapshot": {    "property1": null,    "property2": null  },  "mergeSummary": {    "property1": null,    "property2": null  },  "rejectedReason": "string",  "reviewedAt": "string",  "mergedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "base": {    "id": "string",    "nodeId": "string",    "slug": "string",    "name": "string",    "description": "string",    "reviewPolicy": {      "kind": "single",      "requiredApprovals": 0    },    "createdAt": "string",    "fields": [      {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "type": "text",        "required": true,        "position": 0,        "options": {}      }    ]  },  "node": {    "id": "string",    "parentId": "string",    "type": "folder",    "slug": "string",    "name": "string",    "description": "string",    "metadata": {},    "settings": {},    "explicitVisibility": null,    "icon": null,    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "baseId": "string",    "children": [      {        "id": "string",        "parentId": "string",        "type": "folder",        "slug": "string",        "name": "string",        "description": "string",        "metadata": {},        "settings": {},        "explicitVisibility": null,        "icon": null,        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "baseId": "string",        "children": [          null        ],        "hasChildren": true,        "shared": true      }    ],    "hasChildren": true,    "shared": true  },  "operations": [    {      "id": "string",      "changeRequestId": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operation": "node_create",      "status": "pending",      "targetRecordId": "string",      "targetViewId": "string",      "filePath": "string",      "sourceRecordId": "string",      "sourceCommitId": "string",      "baseCommitId": "string",      "headCommitId": "string",      "deleteMode": "archive",      "mergedRecordId": "string",      "mergedViewId": "string",      "position": 0,      "createdAt": "string",      "updatedAt": "string",      "headCommit": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operationId": "string",        "parentCommitId": "string",        "payload": {          "property1": null,          "property2": null        },        "operation": "node_create",        "message": "string",        "author": "string",        "authorUser": null,        "createdAt": "string"      },      "baseFields": {        "property1": null,        "property2": null      }    }  ],  "primaryOperation": {    "id": "string",    "changeRequestId": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "operation": "node_create",    "status": "pending",    "targetRecordId": "string",    "targetViewId": "string",    "filePath": "string",    "sourceRecordId": "string",    "sourceCommitId": "string",    "baseCommitId": "string",    "headCommitId": "string",    "deleteMode": "archive",    "mergedRecordId": "string",    "mergedViewId": "string",    "position": 0,    "createdAt": "string",    "updatedAt": "string",    "headCommit": {      "id": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operationId": "string",      "parentCommitId": "string",      "payload": {        "property1": null,        "property2": null      },      "operation": "node_create",      "message": "string",      "author": "string",      "authorUser": null,      "createdAt": "string"    },    "baseFields": {      "property1": null,      "property2": null    }  },  "operationCount": 0,  "reviews": [    {      "id": "string",      "changeRequestId": "string",      "reviewerId": "string",      "reviewer": null,      "verdict": "approved",      "reason": "string",      "visibleOperationHeads": {        "property1": "string",        "property2": "string"      },      "createdAt": "string"    }  ]}

List record change request history

Path Parameters

recordId*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/records/string/change-requests"

[  {    "id": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "status": "in_review",    "submittedBy": "string",    "submittedByUser": null,    "sourceAttribution": {      "displayName": "string",      "ownerName": "string",      "channel": "web_ui"    },    "sourceMeta": {      "property1": null,      "property2": null    },    "reviewPolicySnapshot": {      "property1": null,      "property2": null    },    "mergeSummary": {      "property1": null,      "property2": null    },    "rejectedReason": "string",    "reviewedAt": "string",    "mergedAt": "string",    "createdAt": "string",    "updatedAt": "string",    "base": {      "id": "string",      "nodeId": "string",      "slug": "string",      "name": "string",      "description": "string",      "reviewPolicy": {        "kind": "single",        "requiredApprovals": 0      },      "createdAt": "string",      "fields": [        {          "id": "string",          "baseId": "string",          "slug": "string",          "name": "string",          "type": "text",          "required": true,          "position": 0,          "options": {}        }      ]    },    "node": {      "id": "string",      "parentId": "string",      "type": "folder",      "slug": "string",      "name": "string",      "description": "string",      "metadata": {},      "settings": {},      "explicitVisibility": null,      "icon": null,      "position": 0,      "createdAt": "string",      "updatedAt": "string",      "baseId": "string",      "children": [        {          "id": "string",          "parentId": "string",          "type": "folder",          "slug": "string",          "name": "string",          "description": "string",          "metadata": {},          "settings": {},          "explicitVisibility": null,          "icon": null,          "position": 0,          "createdAt": "string",          "updatedAt": "string",          "baseId": "string",          "children": [            null          ],          "hasChildren": true,          "shared": true        }      ],      "hasChildren": true,      "shared": true    },    "operations": [      {        "id": "string",        "changeRequestId": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operation": "node_create",        "status": "pending",        "targetRecordId": "string",        "targetViewId": "string",        "filePath": "string",        "sourceRecordId": "string",        "sourceCommitId": "string",        "baseCommitId": "string",        "headCommitId": "string",        "deleteMode": "archive",        "mergedRecordId": "string",        "mergedViewId": "string",        "position": 0,        "createdAt": "string",        "updatedAt": "string",        "headCommit": {          "id": "string",          "baseId": "string",          "targetType": "base",          "nodeId": "string",          "operationId": "string",          "parentCommitId": "string",          "payload": {            "property1": null,            "property2": null          },          "operation": "node_create",          "message": "string",          "author": "string",          "authorUser": null,          "createdAt": "string"        },        "baseFields": {          "property1": null,          "property2": null        }      }    ],    "primaryOperation": {      "id": "string",      "changeRequestId": "string",      "baseId": "string",      "targetType": "base",      "nodeId": "string",      "operation": "node_create",      "status": "pending",      "targetRecordId": "string",      "targetViewId": "string",      "filePath": "string",      "sourceRecordId": "string",      "sourceCommitId": "string",      "baseCommitId": "string",      "headCommitId": "string",      "deleteMode": "archive",      "mergedRecordId": "string",      "mergedViewId": "string",      "position": 0,      "createdAt": "string",      "updatedAt": "string",      "headCommit": {        "id": "string",        "baseId": "string",        "targetType": "base",        "nodeId": "string",        "operationId": "string",        "parentCommitId": "string",        "payload": {          "property1": null,          "property2": null        },        "operation": "node_create",        "message": "string",        "author": "string",        "authorUser": null,        "createdAt": "string"      },      "baseFields": {        "property1": null,        "property2": null      }    },    "operationCount": 0,    "reviews": [      {        "id": "string",        "changeRequestId": "string",        "reviewerId": "string",        "reviewer": null,        "verdict": "approved",        "reason": "string",        "visibleOperationHeads": {          "property1": "string",          "property2": "string"        },        "createdAt": "string"      }    ]  }]

Create record change request

Path Parameters

recordId*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fields?

Updated field values keyed by field slug. If you set the base's PRIMARY field (its first field), keep it a short human-readable name — it is the record's display title everywhere.

message?||string

author?string

Default"local-producer"

baseCommitId?string

operation*unknown|unknown|unknown

autoMerge?boolean||

submittedBy?|

deleteMode?"archive"

Default"archive"

Value in

"archive"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/records/string/change-requests" \  -H "Content-Type: application/json" \  -d '{    "operation": "update"  }'

{  "id": "string",  "baseId": "string",  "headCommitId": "string",  "parentRecordId": "string",  "parentCommitId": "string",  "status": "active",  "createdBy": "string",  "createdByUser": null,  "fieldUsers": {},  "archivedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "base": {    "id": "string",    "nodeId": "string",    "slug": "string",    "name": "string",    "description": "string",    "reviewPolicy": {      "kind": "single",      "requiredApprovals": 0    },    "createdAt": "string",    "fields": [      {        "id": "string",        "baseId": "string",        "slug": "string",        "name": "string",        "type": "text",        "required": true,        "position": 0,        "options": {}      }    ]  },  "headCommit": {    "id": "string",    "baseId": "string",    "targetType": "base",    "nodeId": "string",    "operationId": "string",    "parentCommitId": "string",    "payload": {      "property1": null,      "property2": null    },    "operation": "node_create",    "message": "string",    "author": "string",    "authorUser": null,    "createdAt": "string"  },  "materialized": true}

Create view change request

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

config?

Default

{  "filters": [],  "sorts": []}

description?string

Default""

message?string

Default"Create view"

name*string

Length1 <= length

type?string

Default"table"

Value in

"table"
"gallery"
"kanban"
"calendar"
"gantt"

slug?string

Match^[a-z0-9-]+$

Length1 <= length

submittedBy?string

Default"local-producer"

autoMerge?boolean

Whether to approve and merge this view change immediately. Omitted defaults to merging immediately if the actor has write access on the Base's node, otherwise falling back to a pending Change Request; pass explicit false to force review even with write access.

operation*unknown

baseId*string

Base the new view belongs to.

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/views/change-requests" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "operation": "create",    "baseId": "string"  }'

{  "id": "string",  "baseId": "string",  "slug": "string",  "name": "string",  "description": "string",  "type": "table",  "config": {    "filters": [],    "sorts": [],    "visibleFieldSlugs": [      "string"    ],    "fieldWidths": {      "property1": 92,      "property2": 92    },    "coverFieldSlug": "string",    "coverFit": "cover",    "cardSize": "small",    "showFieldLabels": true,    "stackByFieldSlug": "string",    "dateFieldSlug": "string",    "startFieldSlug": "string",    "endFieldSlug": "string",    "ganttScale": "week"  },  "status": "active",  "createdBy": "string",  "createdByUser": null,  "archivedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "materialized": true}

Change Requests

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`