Custom Tabs

Retrieve a Custom Tab

Gets a custom tab. NOTE: This will not fetch tab extensions. You must use the GET tab/{tabId}/role/{roleId} for that

get/v2/tab/{tabId}

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/tab/:tabId/get.ts
A function with typed inputs. Its response is checked against the schema.

tabIdinteger required

The Custom Tab that was requested

defaultboolean

idinteger

Tab ID

namestring

Display name of tab

descriptionstring

The description to use for the custom tab

entityType'NODE_ROLE' | 'ORGANIZATION' | 'END_USER' | 'SYSTEM' | 'GLOBAL'

The type of object the tab is for (ie, NODE_ROLE, ORGANIZATION, END_USER, etc)

entityIdinteger

For entity types that are bound to an ID, this will be the id of the object. Otherwise, omitted

parentTabIdinteger

For tab extensions, this will be the id of the tab that was extended (ie, the 'root tab')

positioninteger

Integer representing the position of the tab. Used when ordering multiple tabs

isDefaultboolean

True if this is a default tab, false otherwise