Fieldmotion API Getting started

Communications

Retrieve one notice

POST /a/Notice_get

Retrieve the display fields for one notice owned by the current user.

When to use this endpoint

Use Notice_get after a notice list supplies an ID and the UI needs the full body for its detail dialog.

Authentication and permissions

The request must authenticate with signed API-key fields or a logged-in CRM session. The handler requires login and performs no additional page or role-permission check.

The read or write is limited to the authenticated tenant. Notice endpoints that say “current user” use the authenticated session user ID within that tenant.

Parameters

ParameterTypeRequiredDescription
idInteger-compatibleYesNotice ID. It must convert to an integer of at least 1.

Example request

$notice = FM_api('Notice_get', [
	'id' => '49018',
]);

Example response

{
  "id": "49018",
  "subject": "Policy update",
  "body": "Please review the updated policy.",
  "status": "0",
  "cdate": "1790848200",
  "due_date": "0"
}

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.
{"error":"missing or invalid parameter: id"}id is absent or converts below 1.
{"error":"notice does not exist or is not for you"}The notice does not exist or belongs to another user in the tenant.

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

Behaviour and edge cases

  • The response deliberately omits user_id, meta, original_id, and sdate. There is no field selection or pagination.
  • Both CRM-originated and app-push notices can be retrieved if the current user owns the ID; source metadata is not checked.
  • Reading a notice does not change its status. Call Notice_markSeen separately after presenting it.

See it in Fieldmotion

CRM1

Open the CRM1 notice widget and click a subject. The widget calls Notice_get, renders the body as Markdown, and then marks an unread row seen.

CRM2

No direct CRM2 caller was found; CRM2’s notifications page obtains its displayed fields from Notices_getDataTable and follows metadata links.

Related endpoints