SnozeDevelopers
API referenceDatabases

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.

GET
/v1/workspaces/{workspaceId}/databases/{databaseId}/fields

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string
databaseId*string

Response Body

Success

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://api.snoze.dev/v1/workspaces/string/databases/string/fields'
Example Response
{  "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"    }  ]}

Preview what deleting a database would affect

Walks everything that depends on the database - views, blocks, relations, automations and other references - and returns those entries with an overall status of `safe`, `needs_confirmation`, or `blocked`. Read-only: nothing is deleted. Requires the `databases:write` permission.

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.