Flow Unified API

Endpoints

Two runtime endpoints cover every entity — read and write, selected by mappingKey.

Two runtime endpoints cover every entity. The path carries the connected account and the entity type; the mappingKey query parameter selects which connected system the call targets.

GET  /unified/{accountId}/{entityType}   # Read normalized records
POST /unified/{accountId}/{entityType}   # Write one record to the target system

Parameters

ParameterInRequiredDescription
accountIdPathYesThe connected account the call is scoped to. Find it in the dashboard account switcher.
entityTypePathYesThe unified entity — e.g. customer, order, product, employee. See the API reference for the full list per vertical.
mappingKeyQueryYesSelects the connected system binding to read from or write to. Each entity lists its available read and write keys in the dashboard.
pageSizeQueryNoNumber of records per page on reads. See Pagination.

Read responses return an array of records normalized to the entity's unified schema. Write requests accept one record in that same schema as the JSON body, and return the target system's response mapped back through the unified contract.

On this page