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
25 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.
- GetSourceDataResponse
Paginated rows imported into the source. `total_count` is the full row count in storage; `rows` is the current page.
- GetSourceOptionsData
Response data for Get Source 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.
- PatchSourceStatusResponse
Confirmation of the source's new public lifecycle 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.
- SheetDeleted
Confirmation envelope for a deleted child sheet.
- SourceCreateResponse
Create result envelope. `source_instance_id` is the new source's UUID — pass it to Sync / Get Source Data / Pause-Resume.
- SourceListItem
A source the caller has created. Only sources whose type this API supports are listed.
- SourcePreviewResponse
Preview result envelope. `data` is capped per source (at most 100 rows — e.g. find_job_postings returns up to 25, Slack up to 10). `metadata.total_results` is the upstream count. Per-row keys depend on the source.
- SyncSourceResponse
Confirmation that the source is connected to the workflow.
- User
Caller bootstrap payload. Identity and org membership are always present. Use List Workflows for accessible workflow metadata.
- UserKnowledge
The caller's organization knowledge file: a free-form text/markdown blob describing the org. `exists` is `false` and `content` is `null` when none has been written yet.
- 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.
- WorkflowOverview
Operational info for a workflow: metadata (same fields as List Workflows), sheet roster with settings and webhook URLs, and shared users.
Request bodies
19 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.
- GetSourceOptionsBody
Body for Get Source Field Options. `context` carries any earlier cascading selections (e.g. `{ object_type: "contacts" }` for HubSpot property lookups). Resolvers without cascades accept an empty body.
- ListRowsBody
Body for List Rows. All fields optional. **Filtering** (browse mode only — `filters` / `status_filters` / `created_at` cannot combine with `row_ids`; the server returns 400 if you mix them): - `filters[]` — value filters on **sheet input columns**. Each entry: `{ variable, operator, values }`. `variable` is an `{{input.<column>}}` reference token. - `status_filters[]` — per-action cell-status filters. Each entry: `{ action_instance_id, is?, is_not? }` (exactly one of `is` / `is_not`). - `created_at` — single time filter on the row's creation timestamp. `{ operator, values }`.
- MoveActionBody
Body for Move Action. The moved action is placed immediately after the action identified by `after`.
- PatchSourceStatusBody
Lifecycle control for the source.
- RenameActionBody
Body for Rename Action. Sets the action instance's display name.
- ReorderWaterfallBody
Body for Reorder Waterfall Providers. Lists every currently configured provider `apiId` exactly once, in the desired execution order.
- 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.
- SourceCreateBody
Per-source create body. Shape depends on `source_id` — see the provider README under `modules/sources/` (and optionally `/docs/source-detail/{source_id}.txt`). Validated at the handler level; the schema only enforces that the body is a JSON object.
- SourcePreviewBody
Per-source preview body. Shape depends on `source_id` — see the provider README under `modules/sources/` (and optionally `/docs/source-detail/{source_id}.txt`). Validated at the handler level; the schema only enforces that the body is a JSON object.
- SyncSourceBody
Body for Sync Source to Workflow. Maps workflow inputs to source fields and (by default) backfills existing rows.
- UserKnowledgeBody
Body for Set Org Knowledge. `content` replaces the entire knowledge file.
Supporting types
13 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.
- SourceOptionItem
One value the resolver returned. `value` is what to send back in the source's create / preview payload; `label` is the human-readable text. `extras` carries integration-specific metadata when present (HubSpot property type, list color, etc.).
- SuccessMessage
Simple success response with a confirmation message.
- UserOrgMembers
Members of the caller's organization. Emails are Floqer usernames.
- WorkflowOverviewSheet
A sheet's operational settings within the parent workflow returned by Get Workflow Overview. `sheet_id` is the UUID to pass on sheet-scoped endpoints.