DemandFlow Support Centre

What the DemandFlow REST API is, where it lives, how it authenticates, and how to make your first request.

How to create, manage, and keep safe the Personal Access Tokens used to authenticate with the DemandFlow REST API.

Stream a list of objects of a given entity type whose comboKey starts with the supplied prefix. Returns NDJSON.

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

Create a new object. Returns the created record with its new id. Required system fields are entity, level, and comboKey.

Update one or more fields on an existing object. Returns the updated record with a bumped _df_version. Bypasses any fiel...

Permanently delete an object. Returns 204 on success. The operation is scoped to your subscription and cannot be undone ...

Run several list queries in parallel and stream the combined NDJSON result. Designed for client code that needs many rel...

Reference for DFQL, the streaming query language behind the DemandFlow client. Covers the request envelope, the NDJSON r...

Upload an image or other public asset to your tenant public bucket and get back a direct URL for use in knowledge base a...

Single-page reference for the whole REST API: base URL and tokens, comboKeys, error handling, every endpoint, the stream...