Fieldmotion API Getting started

Saved views and configuration

Retrieve one raw page preference

POST /a/PageSetting_getValue

Read one stored preference without the type conversions performed by the page-list endpoint.

When to use this endpoint

Use for a single raw value, such as the saved advanced-search conditions. For a page’s complete settings use PageSettings_list.

Authentication and permissions

Authenticate with signed API-key fields or a logged-in CRM session. Ordinary page keys, including the literal string false, use the current user; pageLayouts and pageGlobal use tenant-shared user ID 0.

Shared reads need no additional permission. Only the account administrator (user ID equals parent account ID) can write pageLayouts. pageGlobal retains its existing shared-write access for authenticated users.

Parameters

ParameterTypeRequiredDescription
pageStringYesNonempty page key, at most 100 characters. pageLayouts/pageGlobal are shared; every other key is current-user specific.
fieldString or nonempty native list of stringsYesNonempty field key(s), each at most 100 characters. A native list still returns only one raw value: the latest selected row after shared-row precedence.

Example request

$value = FM_api('PageSetting_getValue', ['page' => 'advanceSearch', 'field' => 'jobs']);

Example response

"[{\"column\":\"name\",\"condition\":\"contains\",\"value\":\"Northwind\"}]"

The result is the stored text itself, not a named object or decoded array. Numeric values are strings, for example "12.75".

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: page"}Invalid/missing page; field has equivalent validation.
falseNo matching setting.
{"error":"configuration read failed"}A required database read fails; no write is committed.

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 raw stored text, without numeric/JSON/boolean conversion. JSON-string field lists are literal keys, not decoded lists. No pagination.
  • Queries use bound page parameters and compare field keys as literal text. Reads never migrate or delete preferences.
  • For shared pages only, legacy account-administrator-owned values provide a read-only fallback when a user-ID-0 row for that field is absent. Shared rows take precedence; within a scope the latest row ID wins.

See it in Fieldmotion

CRM1

No direct CRM1 production caller was found. These routes underpin CRM2 server-stored display preferences; CRM1 also keeps client-side display/filter state.

CRM2

Open the CRM2 advanced-search dialog with saved conditions enabled. widgetAdvanceSearch.js requests page advanceSearch, field equal to the widget ID, and parses the raw stored JSON.

Related endpoints