Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

List API - ServiceNow Fluent

The List API defines list views [sys_ui_list] for tables.

Note: For the latest ServiceNow Fluent API documentation and examples, see the ServiceNow Fluent API reference and ServiceNow SDK examples repository on GitHub.

For general information about lists, see ServiceNow AI Platform® list administration.

Parent Topic:ServiceNow Fluent API reference

Related topics

ServiceNow Fluent

List object

Configure lists [sys_ui_list] and their views.

NameTypeDescription
tableStringRequired. The name of the table to which the list applies.
viewReference or StringRequired. The variable identifier or name of the UI view \[sys\_ui\_view\] which applies, or the default view. To define a UI view, use the Record API - ServiceNow Fluent.To use the default view \(`default_view`\), you must import it:
import { default_view } from '@servicenow/sdk/core'
columnsArrayRequired. A list of columns in the table to display in the list, specified using the column name and position in the list.
$metaObject

Metadata for the application metadata.With the installMethod property, you can map the application metadata to an output directory that loads only in specific circumstances.

$meta: {
      installMethod: 'String'
}

Valid values for installMethod:

  • demo: Outputs the application metadata to the metadata/unload.demo directory to be installed with the application when the Load demo data option is selected.
  • first install: Outputs the application metadata to the metadata/unload directory to be installed only the first time an application is installed on an instance.
import { List } from "@servicenow/sdk/core";

List({
    $id: Now.ID["app_task_view_list"],
    table: "cmdb_ci_server",
    view: app_task_view,
    columns: [
        { element: "name", position: 0 },
        { element: "business_unit", position: 1 },
        { element: "vendor", position: 2 },
        { element: "cpu_type", position: 3 },
    ],
});

The UI view definition referenced is defined using the Record object:

import { Record } from "@servicenow/sdk/core";

const app_task_view = Record({
   $id: Now.ID['app_task_view'],
   table: 'sys_ui_view',
   data: {
        name: 'app_task_view',
        title: 'app_task_view'
   }
})