system

List users

Returns list of users

get/v2/users

Request

Base URL
https://app.ninjarmm.com (the document declares no server; this is the origin it was published from)
Auth
- HTTP bearer
- or API key in cookie sessionKey
TypeScript
https://skmtc.dev/ninjarmm/apis/ninjaone-public-api-2-0/docs/v2/users/get.ts
A function with typed inputs. Its response is checked against the schema.

userType'TECHNICIAN' | 'END_USER'

User type filter

includeRolesboolean

Includes user role information

default response

idinteger

User identifier

uidstring uuid

User universally unique identifier

firstNamestring

lastNamestring

emailstring

phonestring

enabledboolean

administratorboolean

permitAllClientsboolean

notifyAllClientsboolean

mustChangePwboolean

mfaConfiguredboolean

userType'TECHNICIAN' | 'END_USER'

invitationStatus'REGISTERED' | 'PENDING' | 'EXPIRED'

organizationIdinteger

Identifier of organization for end-users

deviceIdsinteger[]

Device IDs which end-user is authorized to access

assignedDeviceIdsinteger[]

Device IDs which user is assigned

rolesstring[]

A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'

No recorded changes to this operation across all 4 revisions of this API.