Search ProactiveActionConfigs

GET

api

sys

proactiveactionconfigs

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/proactiveactionconfigs \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/proactiveactionconfigs"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/proactiveactionconfigs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

A ProactiveActionConfig is the settings row for one proactive AI agent at one location: whether it runs at all, whether it may act without human review and above what confidence, how many actions it may raise per day, how long it waits before repeating itself, which delivery channel it prefers, and any custom drafting or voice prompts. There is at most one row per location and CriteriaType, and an agent with no row is off. The default posture is human-in-the-loop: the agent raises ProposedAction records into the operator AI Inbox for review, and only turning on AutoExecute lets sufficiently confident actions go out unattended.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the ProactiveActionConfig-List role.

Enums

eOutboundChannel

Value	Name
1	Email
2	Voice
3	CoworkerMessage
4	HelpDesk
5	WhatsApp

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the location this agent configuration applies to. Each location holds at most one configuration per CriteriaType, and an agent with no configuration row is treated as off..

string

Filter by name of the proactive agent this configuration governs, matching a criteria evaluator: DueInvoiceCriteria, ContractExpiryCriteria, SupportPatternCriteria, SupportIssueCategoryCriteria or MissingFaqCriteria. Unique per location; the actions it produces carry the same value in ProposedAction.CriteriaType..

boolean

Filter by whether this agent runs for the location. When false, or when no configuration row exists at all, the agent is skipped entirely and proposes nothing..

boolean

Filter by whether this agent may act without human review. When true, an action whose confidence reaches AutoExecuteMinConfidence is delivered straight away and recorded as AutoExecuted; anything below it still lands in the inbox. Internal-alert agents ignore this..

number

Filter by confidence an action must reach before AutoExecute will send it without review, on a 0.0–1.0 scale (not a percentage). Defaults to 0.85. Has no effect while AutoExecute is false..

integer

Filter by cap on how many actions this agent may raise for the location in a single day; it also caps how many candidates one evaluation run will consider. Empty means uncapped, in which case a run still considers at most 20 candidates..

integer

Filter by how long the agent waits before raising the same trigger again, in hours; defaults to 24. A candidate is skipped when a non-expired action with the same deduplication key was created inside this window, so in practice it throttles repeat outreach about the same invoice, contract or customer..

integer

Filter by overrides the delivery channel this agent proposes: Email, Voice, CoworkerMessage, HelpDesk or WhatsApp. Empty leaves the choice to the agent’s own default. Voice requires the location’s AI voice channel to be enabled, and WhatsApp requires a configured WhatsApp number..

string

Filter by extra drafting instructions for this agent, up to 2000 characters, appended to its built-in prompt — for example a tone or signature convention. Starting the text with “OVERRIDE:” (case-insensitive) replaces the agent’s whole prompt template instead of adding to it..

string

Filter by opening line spoken or sent when this agent starts an outbound conversation, up to 500 characters. Supports {{variable}} placeholders such as {{company_name}} plus the agent-specific variables listed by the criteria-variables endpoint. Empty uses the built-in opening..

string

Filter by voice-agent system prompt for outbound conversations this agent starts, up to 2000 characters. By default the text is added to the standard prompt; starting it with “OVERRIDE:” (case-insensitive) replaces the standard prompt entirely, and the server then rejects the save unless the text also contains the {{voice_message}} placeholder..

string

Filter by agent-specific thresholds as a flat JSON object of string values, keyed by the parameter keys the criteria-parameters endpoint publishes for this CriteriaType — for example reminder day counts, minimum invoice amounts or ticket thresholds. Empty means every parameter falls back to its published default..

Range Filters

number

Filter by confidence an action must reach before AutoExecute will send it without review, on a 0.0–1.0 scale (not a percentage). Defaults to 0.85. Has no effect while AutoExecute is false. greater than or equal to this value.

number

integer

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/proactiveactionconfigs?page=1&size=15&orderBy=CriteriaType&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/proactiveactionconfigs?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'CriteriaType',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/proactiveactionconfigs',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'CriteriaType',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by CriteriaType

curl -X GET \
  "https://spaces.nexudus.com/api/sys/proactiveactionconfigs?ProactiveActionConfig_CriteriaType=example-value&orderBy=CriteriaType&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/proactiveactionconfigs?' + new URLSearchParams({
    ProactiveActionConfig_CriteriaType: 'example-value',
    orderBy: 'CriteriaType',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/proactiveactionconfigs',
    params={
        'ProactiveActionConfig_CriteriaType': 'example-value',
        'orderBy': 'CriteriaType',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/proactiveactionconfigs?from_ProactiveActionConfig_UpdatedOn=2025-01-01T00:00&to_ProactiveActionConfig_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/proactiveactionconfigs?' + new URLSearchParams({
    from_ProactiveActionConfig_UpdatedOn: '2025-01-01T00:00',
    to_ProactiveActionConfig_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/proactiveactionconfigs',
    params={
        'from_ProactiveActionConfig_UpdatedOn': '2025-01-01T00:00',
        'to_ProactiveActionConfig_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

ProactiveActionConfig[]

The list of ProactiveActionConfig records matching the query. See the Get one ProactiveActionConfig endpoint for the full list of properties returned for each record.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "CriteriaType": "",
      "Enabled": false,
      "AutoExecute": false,
      "AutoExecuteMinConfidence": 0,
      "MaxActionsPerDay": null,
      "CooldownHours": 0,
      "ChannelPreference": 0,
      "CustomPromptOverride": null,
      "FirstMessage": null,
      "SystemPrompt": null,
      "CriteriaConfiguration": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "[email protected]",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "ProactiveActionConfig Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CriteriaType",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search ProactiveActionConfigs

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/proactiveactionconfigs \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/proactiveactionconfigs"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/proactiveactionconfigs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Search ProactiveActionConfigs

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by CriteriaType

Range filters

Response

200