REST queries

REST queries are configured in API Editor for a saved REST connection.

Create a query

1. Open Workspace Settings > Connections > APIs
2. Select your connection
3. Click Open in API Editor
4. Click Create new query
5. Enter a clear query name
6. Set HTTP method
7. Enter endpoint path or full URL
8. Configure Params, Headers, Body, and Bindings
9. Select an auth config (if required)
10. Click Send
11. Validate response and schema
12. Click Save Query

Query fields reference

Query lifecycle checklist

Before first use:

1. Send query and confirm status code
2. Validate response shape matches expected schema
3. Save query

Before production use:

1. Test with realistic runtime bindings
2. Validate empty-state response behavior
3. Validate error-state handling in app actions

Transformer example (flatten nested response)

const from = data.from
const to = data.to

return {
  fromId: from.id,
  fromSections: from.sections,
  toId: to.id,
  toSections: to.sections,
}

After applying a transformer:

1. Click Send.
2. Confirm schema fields.
3. Save the query.

Common issues

• 401/403: wrong or missing auth config.
• 404: wrong path or base URL.
• 400/422: request payload does not match API contract.
• Empty rows with 200: binding values not populated as expected.
• Schema mismatch in app: query changed but app bindings not updated.

Related guides

• REST API
• REST authentication
• REST bindings (tutorial)
• REST variables
• REST query import
• REST pagination