When to use this endpoint

Use for selected notice details; it does not mark them read or reproduce the bell’s current-message filters.

Authentication and permissions

Use signed API-key authentication or a logged-in CRM session on the account’s routed host. API keys act as their owner; normal session requests need dispatcher CSRF protection where configured. Tenant data is selected from the authenticated account.

The handler has no additional page-action/Role check. A CRM2 screen hiding a control does not add such a server guard, and CRM2 role names must not be assumed to apply to CRM1. The dispatcher has no dedicated object-scope mapping for this namespace.

Parameters

ParameterTypeRequiredDescription
id / idsInteger-compatible scalar or native listNoid takes precedence. Positive record IDs are the normal selection. Scalars integer-convert; encoded JSON list text is not decoded. On mapped details, omission or an empty native list adds no ID restriction, so supply another bounded filter deliberately.
fieldsNative list of mapped namesNo for details; required for tablesDetails default to all mapped fields. Unknown names are omitted; id is always included. JSON-encoded list text is not decoded. Whole JSON/text columns remain encoded strings, while nested metadata projections can decode values.
Notice filtersMapped valuesNoid,subject,body,status,userID,cDate,cDateUnix,dueDate,meta,originalID,sDate,metaCreatedBy,metaIsImportant. userID is always replaced with the actor. cDate projects database FROM_UNIXTIME; cDateUnix/dueDate/sDate are raw integer seconds.
Mapped filters / order / advanceSearchScalars, native lists or structured query controlsNoMapped filters combine with AND; lists use IN. Detail text filters are trimmed case-insensitive exact matches; table text filters use substring LIKE. Detail order accepts mapped names or {id,dir} descriptors. Structured comparisons use mapped columns, condition/value and optional andOr/special. These legacy wrappers do not add a strict query-control allowlist; raw advanced conditions are a trusted UI surface, not an integration SQL interface.

Example request

$result = FM_api('Notice_getRequestedDetails', ['id'=>['18'],'fields'=>['id','subject','status','userID']]);

Example response

[
  {
    "id": "18",
    "subject": "Please review",
    "status": "0",
    "userID": "37"
  }
]

Application errors normally remain JSON responses with HTTP 200; inspect error/warning keys. Numeric driver values can be strings.

Errors and unusual responses

ResponseCondition
{"error":"not logged in"}No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.

Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.

Behaviour and edge cases

  • Returns a bare row array for mapped details, not a single object; empty results are []. Whole metadata columns remain encoded strings. Database scalar types remain driver-dependent. The detail helper can also turn a failed database read into [], so it is not a distinct read-failure signal.
  • The actor filter overrides a supplied userID. Other mapped filters still apply, but no implicit status, due-date, future-message or meta.source=push exclusion is added. This is distinct from bell/list filters; it can include your Push-source notices.
  • No pagination, maximum row count or default order. Whole meta remains encoded JSON; nested metadata projections can decode values.

Side effects

  • Reads notices only; no seen timestamp, status change, push, email or acknowledgement.

See it in Fieldmotion

CRM1

No direct exact-route caller found; the bell uses Notice_get/checkNew.

CRM2

No direct current CRM2 caller to this exact route was found. The bell uses other Notice readers; do not assume their status/source filters apply here.

Related endpoints