data.appdata.record.read

Read one owner-scoped appdata record by UUID (routes to the app's storage plane: the shared appdata store, or the app's own Postgres instance when it has one)

Read one owner-scoped appdata record.

Overview

Property	Value
Workflow type	Atomic
Library	App-appdata
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	Authenticated organization UUID
identity_app_uuid	uuid	No	—	(server-resolved principal from the end-user token; input ignored unless it agrees)
database_slug	string	No	—	Virtual database slug. Optional when the authenticated app has exactly one serving database; required when the app has zero or many.
table_slug	string	Yes	—	Virtual table slug
end_user_uuid	uuid	No	—	(server-resolved principal from the end-user token; input ignored unless it agrees)
app_organization_uuid	uuid	No	—	(server-resolved active workspace for organization-mode tables; input rejected if it disagrees)
resource_ref	string	No	—	Optional resource identifier for fine-grained workspace capability checks (ns:verb:resource_ref)
request_id	string	No	—	Caller request id for audit correlation
actor	string	No	—	Workflow caller or agent identifier
record_uuid	uuid	Yes	—	Appdata record UUID

Output Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	Organization UUID echoed from input
identity_app_uuid	uuid	Yes	—	Identity app UUID echoed from input
database_slug	string	Yes	—	Virtual database slug
table_slug	string	Yes	—	Virtual table slug
record_uuid	uuid	Yes	—	Read record UUID
record	dict	No	—	record_uuid, created_at, updated_at + permitted user fields
found	boolean	Yes	—	False when the scoped record was not found
failure_reason	string	No	—	Engine-stamped failure reason
failed_at_state	string	No	—	State when the workflow failed
failed_step	string	No	—	Failed DAG step name
failed_layer	integer	No	—	Failed DAG layer index
error	string	No	—	Engine-stamped exception message
error_type	string	No	—	Engine-stamped exception class name

States

State	Initial	Terminal	Success	Auto-advance	Description
done	Yes	Yes	Yes	—	—

Outcomes

Outcome	Type	Description	State Data Keys
read	SUCCESS	Read one owner-scoped appdata record by UUID (routes to the app's storage plane: the shared appdata store, or the app's own Postgres instance when it has one)	record_uuid
failed	FAILURE	Appdata workflow failed	failure_reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.appdata.record.read",
  "initial_data": {
    "organization_uuid": "value",
    "table_slug": "value",
    "record_uuid": "value"
  }
}