Schemas
Every schema used in the Floqer Public API, grouped by purpose: resources you retrieve, request bodies you send, and supporting types referenced inside them.
Resources
14 schemasTop-level objects returned by the API — the data you query, create, and manipulate.
- ActionGraphNode
One node in the workflow's action graph. `data[0]` is always the synthetic input node (`action_id: "input"`); subsequent elements are actions in topological execution order.
- ActionInstance
An action instance in a workflow sheet's chain. Returned from Add Action and Get Action; contains enough information to subsequently call Configure Action (to wire inputs) or to wire downstream actions to this one (via `outputs[].reference`).
- ActionNote
A note attached to an action instance.
- ActionOutput
A single output field produced by an action instance when it runs. `reference` is the variable token downstream actions use to pull this value. Outputs of type `structured_array` (a list of structured rows) additionally surface their per-column schema under `columns`, each with its own reference token for addressing individual columns.
- AddRowsData
Outcome of an Add Rows batch.
- DeleteAllRowsData
Outcome of a Delete All Rows call.
- DeleteRowsData
Outcome of a Delete Rows batch.
- GetOptionsData
Response data for Get Action Field Options.
- Input
A single configured input field on a workflow sheet. Each input becomes a column in the sheet's data table and gets a `reference` token that downstream actions can use to pull the value.
- ListRowsData
Paginated list of rows with their inputs and per-cell status.
- RunRowsData
Outcome of a Run Rows call.
- Sheet
A sheet in a workflow. Pass `sheet_id` as the `{sheet_id}` path parameter on every sheet-scoped endpoint.
- Workflow
A workflow summary. Timestamps are ISO 8601 UTC; `last_run_at` is `null` until the first run.
- WorkflowDeleted
Confirmation envelope for a deleted workflow.
Request bodies
12 schemasShapes you POST or PUT to the API. Each is used by one or more endpoints.
- AddActionBody
Body for Add Action. `action_id` is the template; `after` (optional) is an `action_instance_id`; `name` (optional) overrides the template's default display name.
- AddRowsBody
Body for Add Rows. Accepts up to 1,000 rows per call.
- ConfigureActionBody
Body for Configure Action. Send only the fields you want to set — unset fields keep their current value.
- CreateSheetBody
Body for Create Sheet. Only `name` is required.
- CreateWorkflowBody
Body for Create Workflow. Only `name` is required.
- DeleteRowsBody
Body for Delete Rows. Accepts up to 200 row UUIDs per call.
- GetOptionsBody
Body for Get Action Field Options. `context` carries any earlier cascading selections (e.g. `{ salesforce_object: "Account" }` for Salesforce field lookups). Resolvers without cascades accept an empty body.
- ListRowsBody
Body for List Rows. All fields optional.
- MoveActionBody
Body for Move Action. The moved action is placed immediately after the action identified by `after`.
- RenameActionBody
Body for Rename Action. Sets the action instance's display name.
- RunRowsBody
Body for Run Rows. Pass either `row_ids` (explicit list) or `first_10: true` (shortcut). Both-or-neither returns 400.
- SaveNoteBody
Body for Save Action Note. Overwrites any existing note on the action.
Supporting types
10 schemasSub-objects referenced inside other schemas. You rarely consume these directly — they describe the building blocks of resources and request bodies.
- ActionInput
A single input field on an action instance. The caller wires this field up via the Configure Action endpoint.
- ConfigureActionWarning
A non-fatal issue detected while applying a Configure Action request.
- DeletedRowRejection
A row UUID the server couldn't delete, with a human-readable reason.
- InputCreate
An input field to add to a workflow sheet. `reference` is server-computed from `name` and is never accepted on the request.
- OptionItem
One value the resolver returned. `value` is what to send back via Configure Action; `label` is the human-readable text. `extras` carries integration-specific metadata when present (Salesforce field metadata, HubSpot property type, etc.).
- RejectedRow
A row the server couldn't accept. Original content is echoed back so the caller can fix and resend without position tracking.
- RowCell
One cell of a row (a single action × a single row). Branch on `status` to decide which of `outputs` / `outputs_ref` / `error` to read.
- RowView
A row on a sheet with its inputs and per-cell action status/outputs.
- RowWarning
A non-fatal issue detected while processing a rows batch.
- SuccessMessage
Simple success response with a confirmation message.