Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NinjaOne system API

Core system Entities and Resources

NinjaOne system API is one of 22 APIs that NinjaOne publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include system. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 24 operations across 24 paths, and defines 42 schemas. It is described by OpenAPI 3.0.1, at version 2.0.9-draft.

Requests are made against the base URL https://app.ninjarmm.com/v2.

24 operations 24 paths 42 schemas 24 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0.9-draft
Base URL
https://app.ninjarmm.com/v2
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

NinjaOne system API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearer) (oauth2). An API key is passed in the cookie as sessionKey (sessionKey). By default, every request must be authenticated.

Paths & Operations 24

Across 24 paths, the API surfaces 24 operations — 24 GET. Each is listed below with its method, path, parameters, and response codes.

system 24

Core system Entities and Resources

GET
/v2/contacts
Contact list
getContacts → 200403
GET
/v2/contact/{id}
Contact details
getContactById 1 param → 200404403401
GET
/v2/organizations
List organizations
getOrganizations 3 params → default
GET
/v2/policies
List policies
getPolicies → default
GET
/v2/jobs
List active jobs
getActiveJobs 4 params → default
GET
/v2/activities
List activities
getActivities 14 params → default
GET
/v2/alerts
List active alerts (triggered conditions)
getAlerts 4 params → default
GET
/v2/automation/scripts
List all available automation scripts
getAutomationScripts 1 param → default
GET
/v2/device-custom-fields
Device Custom Fields
getDeviceGlobalCustomFields 1 param → default
GET
/v2/devices
List devices
getDevices 3 params → default
GET
/v2/devices-detailed
List devices (detailed)
getDevicesDetailed 3 params → default
GET
/v2/notification-channels/enabled
List enabled notification channels
getEnabledNotificationChannels → default
GET
/v2/groups
List groups (saved searches)
getGroups → default
GET
/v2/locations
List locations
getLocations 2 params → default
GET
/v2/roles
List device roles
getNodeRoles → default
GET
/v2/notification-channels
List notification channels
getNotificationChannels → default
GET
/v2/organizations-detailed
List organizations (Detailed)
getOrganizationsDetailed 3 params → default
GET
/v2/tasks
List scheduled tasks
getScheduledTasks → default
GET
/v2/software-products
List supported 3rd party software
getSoftwareProducts → default
GET
/v2/users
List users
getUsers 2 params → default
GET
/v2/devices/search
Find devices
search 2 params → default
GET
/v2/user/end-users
End user list
getEndUsers_1 → 200401403
GET
/v2/user/technicians
Technicians list
getTechnicians → 200401403
GET
/v2/user/roles
Get user roles
getUserRoles 1 param → 200401

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are Device (29 properties), DeviceSearchMatch (27 properties), NodeWithDetailedReferences (24 properties), User (20 properties). Each schema is shown below with its type and property counts.

AttributeContentValue
object
4 properties
DeviceSearchMatch
object
Devices matching search query
27 properties
Activity
object
17 properties
BackupUsage
object
Device Backup Usage
14 properties
OrganizationDetailed
object
10 properties
UserRole
object
5 properties
OrganizationSettings
object
Organization settings
5 properties
NotificationChannel
object
5 properties
Technician
object
17 properties
ScriptVariable
object
Script Variables
8 properties
NodeReferences
object
Expanded entity references
8 properties
Location
object
Location
7 properties
Job
object
17 properties
DeviceSearchResults
object
2 properties
WarrantyDates
object
Warranty Info
3 properties
ScheduledTask
object
7 properties
AttributeContentAdvancedSettings
object
10 properties
Device
object
29 properties
AutomationScript
object
13 properties
NodeRole
object
Device Role
11 properties
FeatureSettings
object
Feature/product/integration configuration settings
4 properties
ActivitiesResponse
object
2 properties
SoftwareProduct
object
5 properties
NodeWithDetailedReferences
object
Device information.
24 properties
LocationWithOrganizationRef
object
8 properties
AttributeContentAdvancedSettingsNumericRange
object
2 properties
AttributeContentAdvancedSettingsComplexityRules
object
4 properties
AttributeContent
object
7 properties
EndUserCustomization
object
3 properties
Contact
object
8 properties
Group
object
10 properties
AttributePublicApiDTO
object
17 properties
Alert
object
14 properties
Maintenance
object
Maintenance mode status
3 properties
User
object
Assigned device owner
20 properties
Note
object
Device Notes
1 property
Policy
object
Assigned policy (overrides organization and location policy mapping)
9 properties
Organization
object
Organization
7 properties
RoleMember
object
Role members
4 properties
NodeRolePolicyAssignment
object
Node role policy assignments
2 properties
AttributeContentAdvancedSettingsDateFilters
object
2 properties
EndUser
object
17 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ninjaone-system-api-openapi.yml Raw ↑

Other APIs NinjaOne publishes across the network.

NinjaOne Asset Tags API
NinjaOne Backup API
NinjaOne Checklist Templates API
NinjaOne Custom Fields API
NinjaOne Custom Tabs API
NinjaOne devices API
NinjaOne Document Templates API
NinjaOne groups API
NinjaOne Knowledge Base Articles API
NinjaOne Location API
NinjaOne management API
NinjaOne organization API