Add a field to a database
Creates a field of the given kind; a relation field also mints the relation itself and, unless `reciprocal` is `false`, the matching field on the other database. Requires the `databases:write` permission and rejects a duplicate key or settings that reference a field that does not exist. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/databases/string/fields" \ -H "Content-Type: application/json" \ -d '{ "label": "string", "kind": "text" }'{ "data": { "id": "string", "workspaceId": "string", "databaseId": "string", "key": "string", "label": "string", "kind": "text", "required": true, "defaultValue": "string", "options": [ { "id": "string", "key": "string", "name": "string", "color": "string", "order": 0 } ], "settings": {}, "order": 0, "createdAt": "string", "updatedAt": "string" }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}List the fields of a database
Returns the database's fields in display order, each with its kind, options, default value, requiredness and kind-specific settings. Requires the `databases:read` permission.
Update a field on a database
Changes a field's label, requiredness, default, options, order or settings, and runs a planned type conversion when `kind` changes - a conversion whose plan drops values is refused unless the caller sets `acceptDropped`. Requires the `databases:write` permission and responds with not-found for an unknown field. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.