DemandFlow Support Centre

API Reference
9 articles
No articles match your search.

API Reference

DemandFlow REST API Overview

Reference
What the DemandFlow REST API is, where it lives, how it authenticates, and how to make your first request.
Updated 16/04/2026

Getting an API Token (PAT)

How-To
How to create, manage, and keep safe the Personal Access Tokens used to authenticate with the DemandFlow REST API.
Updated 16/04/2026

API: GET /v1/entities/{entity}/{comboKey}. List objects

Reference
Stream a list of objects of a given entity type whose comboKey starts with the supplied prefix. Returns NDJSON.
Updated 16/04/2026

API: GET /v1/objects/{id}. Read an object

Reference
Fetch a single object by its id. Returns the full record as JSON, or a 404 if it does not exist in your subscription.
Updated 16/04/2026

API: POST /v1/objects. Create an object

Reference
Create a new object. Returns the created record with its new id. Required system fields are entity, level, and comboKey.
Updated 16/04/2026

API: PATCH /v1/objects/{id}. Update an object

Reference
Update one or more fields on an existing object. Returns the updated record with a bumped _df_version. Bypasses any fiel...
Updated 16/04/2026

API: DELETE /v1/objects/{id}. Delete an object

Reference
Permanently delete an object. Returns 204 on success. The operation is scoped to your subscription and cannot be undone ...
Updated 16/04/2026

API: POST /v1/query. Multi-query streaming

Reference
Run several list queries in parallel and stream the combined NDJSON result. Designed for client code that needs many rel...
Updated 16/04/2026

API: POST /v1/files/public. Upload a public asset

Reference
Upload an image or other public asset to your tenant public bucket and get back a direct URL for use in knowledge base a...
Updated 16/04/2026