---
title: "Retrieve a Custom Tab"
method: GET
path: "/v2/tab/{tabId}"
tags: ["Custom Tabs"]
---

# Retrieve a Custom Tab

`GET /v2/tab/{tabId}`

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

## Path parameters

- `tabId` integer, required

## Response `200`

The Custom Tab that was requested

- object
  - `default` boolean
  - `id` integer — Tab ID
  - `name` string — Display name of tab
  - `description` string — 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)
  - `entityId` integer — For entity types that are bound to an ID, this will be the id of the object. Otherwise, omitted
  - `parentTabId` integer — For tab extensions, this will be the id of the tab that was extended (ie, the 'root tab')
  - `items` object[] — The content of the tab
    - `id` integer — ID of an attribute
    - `name` string — Name of the content item
    - `fieldName` string — Field name of the attribute
    - `description` string — Description of the content item
    - `entityType` 'USER' | 'NODE' | 'TICKET' | 'DOCUMENT' — Entity type that this custom field or operation applies to
    - `attributeType` 'DROPDOWN' | 'MULTI_SELECT' | 'CHECKBOX' | 'TEXT' | 'TEXT_MULTILINE' | 'TEXT_ENCRYPTED' | 'NUMERIC' | 'DECIMAL' | 'DATE' | 'DATE_TIME' | 'TIME' | 'ATTACHMENT' | 'NODE_DROPDOWN' | 'NODE_MULTI_SELECT' | 'CLIENT_DROPDOWN' | 'CLIENT_MULTI_SELECT' | 'CLIENT_LOCATION_DROPDOWN' | 'CLIENT_LOCATION_MULTI_SELECT' | 'CLIENT_DOCUMENT_DROPDOWN' | 'CLIENT_DOCUMENT_MULTI_SELECT' | 'EMAIL' | 'PHONE' | 'IP_ADDRESS' | 'WYSIWYG' | 'URL' | 'MONETARY' | 'IDENTIFIER' | 'TOTP' — The type of custom field that determines how data is stored and displayed
    - `attributeScope` 'NODE_GLOBAL' | 'NODE_ROLE' | 'NODE_CLASS' — Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)
    - `definitionScope` string[] — Definition scopes of the attribute
    - `technicianPermission` 'NONE' | 'EDITABLE' | 'READ_ONLY' | 'ROLE_BASED' — Technician access level for custom fields
    - `scriptPermission` 'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE' — Script access level for custom fields via automation
    - `apiPermission` 'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE' — Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)
    - `defaultValue` string — For multi-select attributes, this is the id of the default value
    - `content` object — For multi-select attributes, these are the available content options
      - `customizeForEndUser` boolean — Whether the attribute should be customized for end users
      - `endUserCustomization` object
        - `name` string
        - `description` string
        - `label` string
      - `values` object[] — For multi-select attributes, this is the list of values available
        - `id` string, uuid
        - `name` string
        - `active` boolean
        - `system` boolean
      - `required` boolean — Boolean representing whether the attribute is required or not
      - `footerText` string — Text to include after rendering the attribute
      - `tooltipText` string — Text to use as a tooltip for the attribute
      - `advancedSettings` object
        - `fileMaxSize` integer
        - `fileExtensions` string[]
        - `dateFilters` object
          - `type` 'NONE' | 'INCLUDE' | 'EXCLUDE' | 'PAST_DATES_ONLY' | 'FUTURE_DATES_ONLY' | 'RANGE' — Date filtering options for date/time custom fields
          - `selected` string[]
        - `maxCharacters` integer
        - `complexityRules` object
          - `mustContainOneInteger` boolean
          - `mustContainOneLowercaseLetter` boolean
          - `mustContainOneUppercaseLetter` boolean
          - `greaterOrEqualThanSixCharacters` boolean
        - `numericRange` object
          - `min` number
          - `max` number
        - `org` integer[]
        - `nodeClass` string[]
        - `ipAddressType` 'ALL' | 'IPV4' | 'IPV6' — IP address validation type for IP address custom fields
        - `expandLargeValueOnRender` boolean
        - `identifier` object
          - `automaticGenerationEnabled` boolean
          - `scope` 'NONE' | 'GLOBAL' | 'ORGANIZATION'
          - `assignTo` 'NEW_ASSETS_ONLY' | 'NEW_AND_EXISTING_ASSETS'
          - `type` 'CUSTOM' | 'SEQUENCE'
          - `nextSequenceNumber` integer
          - `prefix` string
          - `suffix` string
        - `monetary` object
          - `currency` 'USD' | 'EUR' | 'CAD' | 'GBP' | 'AUD' | 'JPY' | 'SEK' | 'NOK' | 'DKK' | 'CHF' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHE' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYI' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAD' | 'XAF' | 'XCD' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG'
        - `templates` integer[]
        - `nodeRole` integer[]
    - `active` boolean — Whether the attribute is active or not
    - `createTime` number, double — The time that the attribute was created (unix epoch)
    - `updateTime` number, double — The time that the attribute was last updated (unix epoch)
    - `uiElementUid` string, uuid — For UI elements, the uuid of the element
    - `uiElementType` 'TITLE' | 'DESCRIPTION' | 'SEPARATOR' — For UI elements, type of the element
    - `uiElementValue` string — For UI elements, value of the element
    - `uiElementCreateTime` number, double — For UI elements, timestamp of when the element was created (unix epoch)
    - `uiElementUpdateTime` number, double — For UI elements, timestamp of when the element was last updated (unix epoch)
  - `position` integer — Integer representing the position of the tab. Used when ordering multiple tabs
  - `isDefault` boolean — True if this is a default tab, false otherwise

## Other responses

- `404` — No custom tab could be found with that ID

---

[API](https://skmtc.net/ninjarmm/apis/ninjaone-public-api-2-0.md) · [All operations](https://skmtc.net/ninjarmm/apis/ninjaone-public-api-2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ninjarmm/ninjaone-public-api-2-0/versions/753f26d46650/schema)