Fieldmotion API Getting started

Reporting dashboards and targets

List globally shared dashboard groups

POST /a/ReportDashboardGroups_listAllOnly

List groups containing the All token in sharedUser for embedding in layouts.

When to use this endpoint

Load this list before selecting a dashboard group or embedding it in a layout. Load the chosen group’s widgets separately; this endpoint does not execute reports.

Authentication and permissions

Authenticate with signed API-key fields or a logged-in CRM session. All lookups and writes are tenant-local.

Group list visibility follows ownership and shares; the embedding list is restricted to effective All view shares. None disables its share array; otherwise string user IDs or All grant that share. No reporting-feature or additional CRM2 page-role check is applied.

For signed form requests, sign numeric scalar values as strings, including values inside native nested arrays. Send JSON text only for parameters explicitly accepting JSON strings; see Getting started.

These reporting handlers require tenant schema upgrade 794 before deployment. No request path creates or repairs schema.

Parameters

This endpoint has no operation-specific parameters.

Example request

$result = FM_api('ReportDashboardGroups_listAllOnly', []);

Example response

[{"id":"12","name":"Sales","user_id":"7","cdate":"2026-10-02 09:00:00"}]

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

  • Only an effective All view share selects a group: sharedUser must contain JSON string All and must not contain None. Edit-only All shares do not select it.
  • Only active groups are returned; either dashboard mode can appear. Ownership and explicit direct shares do not add a group to this embedding list.
  • Sorted by name, no pagination, no matches return []. Creation time uses database FROM_UNIXTIME.

Side effects

  • Read-only; no records or edit timestamps are changed.

See it in Fieldmotion

CRM1

No direct caller was found.

CRM2

The display-layout editor uses this list to select a globally shared report group to embed, then loads its widgets through ReportDashboards_list. Filter browser Network requests for ReportDashboardGroups_listAllOnly.

Related endpoints