Developers

Build on top of it, not just configure it.

A REST API and an MCP server, both first-class. Model record types, automate writes, and give AI agents scoped access — all programmatically.

Quickstart

Get an API key, make your first call.

1 Generate an API key from your workspace settings.
2 Pick a record type — or create one — to read or write.
3 Call the REST API directly, or register an MCP endpoint for AI clients.

curl -X GET "https://api.on-flow.co.uk/v1/records?type=customer" \
  -H "Authorization: Bearer <api-key>"

{
  "data": [
    { "id": "rec_123", "type": "customer", "name": "Acme Inc." }
  ]
}

Authentication

Every request uses a Bearer API key scoped to a workspace and role. Keys can be restricted to specific record types and actions.

Request enterprise SSO/SCIM

API reference

OnFlow API

Placeholder specification. This will be replaced with the generated OnFlow OpenAPI spec — the explorer below renders whatever spec is dropped in.

get/record-types

List record types

Returns every record type defined in the workspace.

Parameters

limit

query

Max number of results.

Request

curl -X GET "https://api.on-flow.co.uk/v1/record-types" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json"

Example response

{
  "data": [
    {
      "id": "rt_customer",
      "name": "Customer"
    }
  ]
}

Get an API key, start building.

Every plan includes full API and MCP access from the first day of your trial.

Start free trial Explore MCP

1-month free trial • Cancel any time