Get all AIRecommendations

Overview

Retrieve a list of AIRecommendations with optional filtering by status, target, and context.

Available for Staff, Directory, and Client tokens

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
1 to 10000
Defaults to 1

Page number of results.

number
1 to 100
Defaults to 25

How many items to return per page. Max: 100

string
Defaults to updated_at:desc

Sort by fields. Example: sort=created_at:asc,updated_at:desc

string
enum

Filter by recommendation lifecycle state: 'active', 'completed', 'dismissed', 'approved', or 'snoozed'.

Allowed:
string

Filter by target actor UID.

string

Filter by context UID.

string
enum

Filter by category bucket. Each record belongs to one bucket only, checked in this order:
upcoming – due_at is in the future (based on time, even if the stored category is different).
fyi – due_at is not in the future and execution_policy is auto_execute (again, based on fields, not stored category).
needs_attention / opportunity – stored category is one of these, due_at is not in the future, and execution_policy is requires_human_approval.

Allowed:
string

Filter by the record's 'producer' (creation source). When omitted, only legacy records with an empty 'producer' are returned (default). Pass 'any' to return only records that have a non-empty 'producer', or pass a specific producer value (for example: 'client_agent') to return only records from that producer.

string
enum
Defaults to my_view

Which staff members' recommendations to return. 'my_view' (default) returns only the caller's own recommendations; 'team' returns recommendations across every staff member in the business, subject to the caller having permission to view other staff members' entities (e.g., "my_view", "team").

Allowed:
include
array of strings

Optional data sets to include in the response, beyond the recommendations list. Supported values: 'counts' (adds per-category totals under 'meta.counts'). Repeat the parameter to request multiple. When omitted, no extra data is returned and 'meta' is absent.

include
Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json