Skip to main content
GET
List intent rules
Returns intent rules in the workspace as summary objects.

Headers

string
required
Bearer token containing your Fini workspace API key. Format: Bearer fini_... The key needs read scope.

Query parameters

string
required
Send intent.
string
Version state to return: DRAFT, PUBLISHED, or ARCHIVED. Defaults to PUBLISHED.
boolean
Set to true to include botIds, current-published metadata, latest-draft metadata, draftCount, and lastPublishedAt. Defaults to false.

Response

Returns an array of Rule summary objects without flowConfig.

Fields added by includeVersions=true

RuleVersion | null
The active published version, or null when the rule has not been published. Uses the shared Rule version shape without flowConfig.
RuleVersion | null
The most recent draft version, or null when the rule has no draft. Uses the shared Rule version shape without flowConfig.
number
Number of draft revisions represented by the latest draft relative to the current published version.
string | null
ISO 8601 publication timestamp for the current published version. If its publication timestamp is unavailable, the API uses that version’s last-update timestamp. Returns null when the rule has not been published.
With includeVersions=false, intent-rule summaries omit botIds. Use includeVersions=true for a lifecycle overview, or Get intent rule for the full tree.

Errors

A query parameter is malformed or uses an unsupported enum value.
The API key is missing, malformed, revoked, or invalid.
The API key does not include the read scope required for this route.
Fini failed while loading intent rules.