Skip to content

Query objects

POST
/v1/functions/hospitality.function.query_objects/invoke
curl --request POST \
--url https://api.aerandil.com/v1/functions/hospitality.function.query_objects/invoke \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "params": { "filters": "example", "limit": 1, "object_type": "example" } }'

Query objects of one type, optionally narrowed by conjunctive equality filters, returning up to limit summaries ordered by creation time (oldest first). Reads through the caller’s authority and any active branch overlay — under a preview it composes the draft’s own hypothetical writes, so it is the read-your-writes search surface for agents. Marking-redacted exactly like get / list: a value the caller cannot read is absent and cannot be filtered on. Each hit is {id, object_type, properties} with flat property values. Read-only — emits no edits.

Media typeapplication/json
object
params
required
object
filters
Conjunctive equality filters as a JSON object {property_api_name: value}
limit
Maximum hits to return (default 50, capped at 200)
integer
object_type
required
Object-type api name to query
string
Examplegenerated
{
"params": {
"filters": "example",
"limit": 1,
"object_type": "example"
}
}

Function invoked. The body carries the typed return_value shaped by the function’s declared return_type.

Media typeapplication/json
InvokeFunctionResponse

Envelope returned by the Aerandil function engine. correlation_id is the per-invocation id for trace stitching; return_value is the typed value the function computed (shape declared by the function’s return_type).

object
correlation_id
required

Per-invocation correlation id; appears on log/trace records this function emitted.

string format: uuid
return_value
required
Array
Examplegenerated
{
"correlation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"return_value": [
"example"
]
}
Cache-Control
string

Always no-store — function results are time-sensitive and never cacheable.

Function or target object not found.

Parameter validation or domain-rule violation.