Read masked waste-tracking settings

When to use this endpoint

Read this before editing account settings or constructing a complete settings replacement. Use the paginated profiles call for the CRM2 table.

Authentication and permissions

Authenticate with signed API-key fields or a logged-in CRM session; session dispatch applies CSRF checks. The authenticated tenant must have features2.ukDigitalWasteManagement=1. The feature is read from the account record, not trusted from request input.

Requires client-administrator access. A page Edit permission or wildcard role alone does not replace the client-admin check.

Parameters

This endpoint has no operation-specific parameters.

Example request

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

Example response

{
  "version": 2,
  "default_profile_id": "aaaaaaaaaaaaaaaa",
  "notification_user_ids": [],
  "profiles": [
    {
      "id": "aaaaaaaaaaaaaaaa",
      "name": "North receiving site",
      "environment": "test",
      "receiving_site": {
        "receiver": {
          "siteName": "North receiving site",
          "authorisationNumber": "EPR/AB1234CD",
          "emailAddress": "waste@example.test",
          "phoneNumber": "",
          "regulatoryPositionStatements": []
        },
        "address": {
          "fullAddress": "1 Synthetic Road",
          "postcode": "BT1 1AA"
        }
      },
      "submission_mode": "manual",
      "active": 1,
      "api_code_masked": "",
      "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ],
  "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

Errors and unusual responses

Response	Condition
`{"error":"not logged in"}`	No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.
`{"error":"UK Digital Waste Tracking is not enabled for this account"}`	The account feature is disabled.
`{"error":"client administrator access required"}`	The identity is not a client administrator.

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 the settings object directly, with no ok envelope. Every profile includes api_code_masked: blank when no code is saved, otherwise four bullet characters followed by the last four characters. Raw api_code is removed; other receiving-site contact details remain visible to the administrator.
Legacy single-site settings are converted in memory to version=2 with profile ID legacy-default, name Default receiving site, active=1, default_profile_id=legacy-default and an empty notification recipient list. Reading does not persist this upgrade.
Returns active and archived profiles in stored order, without filtering, pagination or a reference/provider call. Notification IDs are integer-converted, deduplicated and filtered for nonzero values on read; active-user validation occurs on save.
Returns an opaque revision of the private current configuration, both at the top level and on each public profile. Echo it when saving settings or an edited profile to reject stale edits. It does not expose the raw saved API code.

See it in Fieldmotion

CRM1

No direct CRM1 caller was found in the production JavaScript source. The operator workflow is implemented in CRM2.

CRM2

Open Settings > Digital Waste Tracking and edit notification recipients. Filter for DigitalWasteTracking_settingsGet; CRM2 reads this object before sending its modified settings to DigitalWasteTracking_settingsSave.

Related endpoints

DigitalWasteTracking_settingsSave — Save a complete settings update.
DigitalWasteTracking_profiles — Search and page the same masked receiving profiles.
DigitalWasteTracking_readiness — Check configuration gaps separately.