Fieldmotion API Getting started

User role access

Retrieve the role-access catalogue

POST /a/UserRoleAccess_getAccessList

Return the server-defined CRM and mobile-app access catalogue used to build the CRM2 role-access tree.

When to use this endpoint

Use UserRoleAccess_getAccessList to discover the current access categories/field identifiers before displaying or saving role access.

Authentication and permissions

This handler does not require login or a role permission. The normal API dispatcher/IP restrictions still apply, but an otherwise unauthenticated request can receive the catalogue.

When a tenant session exists, session feature values can alter the returned catalogue. The endpoint does not query or mutate tenant tables.

Parameters

This endpoint has no operation-specific parameters.

Example request

$catalogue = FM_api('UserRoleAccess_getAccessList');

Example response

{
  "pageUserRoles": {
    "parent": "pageUsersMain",
    "name": "Roles",
    "type": "menu",
    "access": [
      {"id":"view","name":"View"},
      {"id":"add","name":"Add"},
      {"id":"edit","name":"Edit"},
      {"id":"delete","name":"Delete"}
    ]
  }
}

The real response is a large JSON object keyed by page/category ID. Entries can also contain link, icon, tabName, or access-item title metadata.

Errors and unusual responses

ResponseCondition
No operation-specific errorThe checked-in access catalogue loads successfully; unsupported request parameters are ignored.

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

Behaviour and edge cases

  • When session value features2.useRODefault is not integer-like 1, the top-level pageRequisitionOrders and pageRequisitionOrder categories are removed. This also happens without a tenant session.
  • The function returns the in-memory catalogue in its declared order. There is no search, field selection, or pagination.
  • The response describes possible access fields; it does not indicate which ones a particular role currently has.

See it in Fieldmotion

CRM1

No direct CRM1 caller was found.

CRM2

Open a role’s Access page. CRM2 loads this catalogue alongside the role’s stored access rows and builds the permission tree.

Related endpoints