---
title: "Custom fields detailed report"
method: GET
path: "/v2/queries/custom-fields-detailed"
tags: ["queries"]
---

# Custom fields detailed report

`GET /v2/queries/custom-fields-detailed`

## Request

- Base URL: `https://app.ninjarmm.com` (the document declares no server; this is the origin it was published from)
- URL: `https://app.ninjarmm.com/v2/queries/custom-fields-detailed`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `sessionKey`
- TypeScript: <https://skmtc.dev/ninjarmm/apis/ninjaone-public-api-2-0/docs/v2/queries/custom-fields-detailed/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns Custom Fields report with additional information about each field

## Query parameters

- `df` string
- `cursor` string
- `pageSize` integer
- `updatedAfter` string
- `fields` string
- `showSecureValues` boolean

## Response `default`

default response

- object
  - `cursor` object
    - `name` string
    - `offset` integer
    - `count` integer
    - `expires` number, double
  - `results` object[]
    - `deviceId` integer: Entity identifier
    - `entityType` 'NODE' | 'END_USER' | 'LOCATION' | 'ORGANIZATION' | 'GLOBAL': Defines what entity types can use this custom field definition
    - `fields` object[]: Field values
      - `name` string: Field name
      - `value` object: Field Value
      - `updated` number, double: Last field update timestamp
      - `updatedBy` object: Value source (who/what updated the value)
        - `source` 'API' | 'USER' | 'SCRIPT' | 'SYSTEM'
        - `user` object
          - `id` integer
          - `name` string
          - `email` string
      - `updateTime` number, double
    - `entityId` integer

## Changes

- **2026-07-26** `753f26d46650`: 1 warning
  - added the new `GLOBAL` enum value to the `results/items/entityType` response property for the response status `default`
- **2025-12-12** `7c00bdd989ee`: 3 warning, 3 info
  - removed the optional property `results/items/definitionScope` from the response with the `default` status
  - added the new `END_USER` enum value to the `results/items/entityType` response property for the response status `default`
  - added the new `SYSTEM` enum value to the `results/items/fields/items/updatedBy/source` response property for the response status `default`
  - added the new optional `query` request parameter `showSecureValues`
  - …2 more
- **2024-03-04** `8811c70de9a8`: 4 info
  - added the optional property `results/items/definitionScope` to the response with the `default` status
  - added the optional property `results/items/entityId` to the response with the `default` status
  - the response optional property `results/items/deviceId` became write-only for the status `default`
  - added the optional write-only property `results/items/entityType` to the response with the `default` status

[Operation history](https://skmtc.dev/ninjarmm/apis/ninjaone-public-api-2-0/changes/v2/queries/custom-fields-detailed/get.md)

---

[API](https://skmtc.dev/ninjarmm/apis/ninjaone-public-api-2-0.md) - [All operations](https://skmtc.dev/ninjarmm/apis/ninjaone-public-api-2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/ninjarmm/apis/ninjaone-public-api-2-0/revisions/5ce571d1bb71?raw)