Actions309
- System Actions
- Contact list
- Contact details
- List organizations
- List policies
- List active jobs
- List activities
- List active alerts (triggered conditions)
- List all available automation scripts
- Device Custom Fields
- List devices
- List devices (detailed)
- List enabled notification channels
- Global custom fields
- Update global custom field values
- List groups (saved searches)
- List locations
- List device roles
- List notification channels
- List organizations (Detailed)
- List scheduled tasks
- List supported 3rd party software
- List users
- Find devices
- End user list
- Technicians list
- Get user roles
- Management Actions
- Create a contact
- Update a contact
- Delete a contact
- Get custom fields policy conditions
- Create custom fields policy condition
- Get windows event conditions
- Create windows event condition
- Delete policy condition
- Get custom fields policy condition
- Get windows event condition
- Create new organization
- Approve/Reject devices
- Reset alert/condition
- Reset alert/condition and provide custom data for activity
- Schedule maintenance
- Cancel maintenance
- Windows service control
- Decommission device
- Update device information
- Device link
- Reset device policy overrides
- Reboot device
- Remove device owner
- Device scripting options
- Run script or built-in action
- Set device owner
- Modify Windows Service configuration
- Run OS patch apply
- Run OS patch scan
- Run Software patch apply
- Run Software patch scan
- Add new location to organization
- Generate installer
- Update organization
- Update location
- Change organization policy mappings
- Creates new Policy
- Create end user
- Update a specific end user
- Delete end user
- Update device access for end user
- Create a technician
- Update a technician
- Delete a technician
- Add user role members
- Remove users from user role
- Set organization access permissions for a role
- NodeRoles Actions
- Webhooks Actions
- KnowledgeBaseArticles Actions
- Upload temporary attachments
- Archive knowledge base articles
- Archive knowledge base folders
- Create knowledge base articles
- Update knowledge base articles
- Delete knowledge base articles
- Delete knowledge base folders
- Download knowledge base article
- Get knowledge base article
- Lists organization knowledge base articles
- Get global knowledge base article
- Lists global knowledge base articles
- Get knowledge base article signed urls
- Returns knowledge base folder
- Move knowledge base items
- Restore archive knowledge base articles
- Restore archived knowledge base folders
- Upload knowledge base articles
- Download related item attachment
- Get related item attachments signed urls
- ChecklistTemplates Actions
- OrganizationChecklists Actions
- Archive organization checklists
- List client checklists
- Create organization checklists
- Update organization checklists
- Create organization checklists from templates
- Get client checklist
- Delete an organization checklist
- Delete organization checklists
- Get organization checklist signed urls
- Promote organization checklists
- Restore organization checklists
- OrganizationDocuments Actions
- Archive an organization document
- Archives organization documents
- Create organization document
- List all organization documents with field values
- Create organization documents
- Update organization documents
- Delete an archived organization document
- Get organization document signed urls
- List organization documents with field values
- Restore an organization document
- Restore multiple multi page organization documents
- Update organization document
- DocumentTemplates Actions
- AssetTags Actions
- CustomFields Actions
- RelatedItems Actions
- AssetRelationships Actions
- SoftwareLicenses Actions
- UnmanagedDevices Actions
- Backup Actions
- Billing Actions
- Get all accounts
- Creates a new account
- Get specific account
- Updates an account
- Deletes an account
- Retrieves an agreement list.
- Creates an agreement.
- Deactivate agreement
- Retrieves an agreement given its ID.
- Updates an agreement.
- Approves invoices
- Archive invoices
- Get all invoices
- Creates an invoice
- Export invoices
- Get invoice by ID
- Updates an invoice
- Unarchive invoices
- Update invoice note
- Activates a product
- Get all products
- Creates a product
- Deactivates a product
- Get product by ID
- Updates a product
- Creates an adhoc ticket product.
- Creates a catalog ticket product.
- Get all products related to a ticket
- Removes a list of ticket products from a ticket
- Updates a ticket product.
- Updates PSA properties of a ticket time entry
- CustomTabs Actions
- Create a new Custom Tab
- Retrieve a Custom Tab
- Update a Custom Tab
- Delete a Custom Tab
- Get End User
- Get Organization
- Get Role
- Retrieve all of the custom tabs available to end user views
- Retrieve all of the custom tabs available for global scope
- Rename a Custom Tab
- Set the tab visibility of the specified tab
- Update the order of custom tabs for end-user tabs
- Update the order of custom tabs for global scope
- Update Order
- Update the order of custom tabs for a specific role
- Ticketing Actions
- VulnerabilityManagement Actions
- Devices Actions
- Device details
- Device currently running (active) jobs
- Device activities
- Device alerts (triggered conditions)
- Device disk drives
- OS Patch installation report for device
- Software Patch history for device
- Last logged-on user information
- Device network interfaces
- OS Patches
- Pending, Failed and Rejected Software patches for device
- Device processors
- Windows services
- Device software inventory
- Device storage volumes
- Device custom fields
- Update Field Values
- Get summary of device policy overrides
- Geolocation Actions
- Groups Actions
- Organization Actions
- Location Actions
- Queries Actions
- Antivirus status report
- Antivirus threats report
- Computer systems report
- Custom fields detailed report
- Custom fields report
- Device health report
- Device backup usage
- Disk drives report
- OS Patch installation report
- Software Patch history report
- Last logged-on user report
- List Network Interfaces
- Operating systems report
- Pending, Failed and Rejected OS patches report
- Pending, Failed and Rejected Software patches report
- Get summary of device policy overrides
- Processor report
- RAID controller report
- RAID drive report
- Scoped custom fields detailed report
- Scoped custom fields report
- Software inventory
- Disk volumes report
- Windows services report
- Users Actions
CustomFields → Get custom field by field name
AI-generatedSummary
Retrieve details of a custom field by specifying its unique field name in NinjaOne.
Inputs
- fieldName (required) — The unique field name of the custom field to retrieve.
- options — Optional settings including custom request body JSON (merged with the default), custom HTTP headers, query-string filters, batching configuration for processing multiple inputs, debug output toggling, pagination controls, and request timeout in milliseconds.
Output shape
a single JSON object representing the custom field details returned by the NinjaOne API.
The output may include a debug entry containing request details if the Debug option is enabled. Supports batching to handle multiple input items individually. Pagination options are present but typically not applicable for this single-item retrieval operation.
Examples
Example 1: Retrieve a custom field's details by its field name 'exampleFieldName'.
Set the 'Field Name' input with the field's unique name; optionally customize headers or query parameters if needed.