data.appdata.document.query

List end-user documents visible under the app visibility predicate (shared storage plane; an app served from its own instance reads and writes through the Data API instead)

List documents visible to the authenticated end-user.

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)
end_user_uuid	uuid	No	—	(server-resolved principal from the end-user token; input ignored unless it agrees)
request_id	string	No	—	Caller request id for audit correlation
actor	string	No	—	Workflow caller or agent identifier
ref_table_slug	string	No	—	Filter by appdata record table slug
ref_record_uuid	uuid	No	—	Filter by appdata record UUID
kind	string	No	—	Filter by document kind
limit	integer	No	—	Result limit
offset	integer	No	—	Pagination offset

Output Schema

Field	Type	Required	Default	Description
documents	list	Yes	—	Visible document metadata rows
count	integer	Yes	—	Number of returned documents
limit	integer	Yes	—	Applied result limit
offset	integer	Yes	—	Applied offset
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
queried	SUCCESS	List end-user documents visible under the app visibility predicate (shared storage plane; an app served from its own instance reads and writes through the Data API instead)	count
failed	FAILURE	Appdata workflow failed	failure_reason

API Usage

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

{
  "workflow_type": "data.appdata.document.query",
  "initial_data": {
    "organization_uuid": "value"
  }
}