---
title: "Partner List"
slug: "partner-list-widget"
updated: 2026-04-17T07:40:53Z
published: 2026-04-17T07:40:53Z
canonical: "learn.servitly.com/partner-list-widget"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://learn.servitly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Partner List

This widget displays the list of partners visible to the user and navigation context. An Organization user will see all the partners associated with its parent organization, or with a partner; instead, a Partner user will see all the sub-partners. In the case of an organization user, the “*Show all Partners*” option allows you to upload all partners, including those associated with sub-organizations, recursively.

The list supports pagination, and items can be searched and sorted based on properties. The list shows one column for each property or composite part defined in the template, and each value can be displayed through [filters](/v1/docs/filters), if needed.

![Partner List](https://components-manager.servitly.com/components/PartnerList_1/IMAGES/_screenshot?owner=AG_Servitly)

Below the list, you can interact with the pagination control (default 20 items at a time). This is automatically hidden if there are fewer items than the number of items to be loaded per page (configurable with the “*Page Size*” option). Entering the page, the list is sorted by the first column ascending, but optionally, you can refine it through the “*Initial Sorting*“ widget property.

This widget requires the `READ_PARTNER` user’s [permission](/v1/docs/user-permissions).

## Search for Partners

On the top right part of the widget, a search control bar allows filtering partners by a text key.

![](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/image(900).png?sv=2022-11-02&spr=https&st=2025-09-24T15%3A02%3A46Z&se=2025-09-24T15%3A19%3A46Z&sr=c&sp=r&sig=MUUjY9Ut0pgZzoKZ8krDsQxKTEV3P%2FG8UW1wP2aTicQ%3D)

Optionally, by pressing the *Advanced Search* icon, a dedicated panel allows the DPS user to specify multiple conditions based on properties.

![](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/image(908).png)

The provided inputs are preserved during navigation, also across pages in case the same widget “*Id*” is used. Optionally, by using the “*Query*“ property, a set of conditions for pre-filtering items can be defined in the template. In the template, you can specify the “*Search Fields*“ used to filter things by text key. In case the “*Query Variable*“ property has been defined (the list is filtered from a [Search Field](/v1/docs/search-field) placed in the page), the search control bar is automatically hidden and thus not visible to the user.

## Create a new Partner

If the widget option “*Actions Enabled*“ is selected, by pressing the “*Add Partner*“ button, the DPS user can manually create a new partner under the current location. This requires the `WRITE_PARTNER` user’s [permission](/v1/docs/user-permissions).

![](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/image(909).png)

## Template Syntax

Below you can find some examples of how to use the component within a template.

```xml

<partner-list-widget-v2>
            <property name="code"></property>
            <property name="name" label="Name"></property>
            <property name="properties.city"></property>
            <property name="properties.country" label="Country"></property>
            <property name="customerCount"></property>
</partner-list-widget-v2>
        
```

## Component Reference

Here is a comprehensive list of all the elements and properties that can be used to configure the component.

#### Partner List `&lt;partner-list-widget-v2&gt;`

| *Actions Enabled* | The boolean flag indicating whether actions (e.g. Add button) are enabled on the widget. **Name**: enableActions **Type**: BOOLEAN \| Optional **Default Value**: *true* `[enableActions]="false"` |
| --- | --- |
| *Block Column Span* | The number of columns on which to span the properties displayed in each list block (default 1). **Name**: blockColumns **Type**: INTEGER \| Optional **Default Value**: *1* `blockColumns="2"` |
| *Bulk Controls Enabled* | The boolean flag indicating whether bulk selection and buttons (e.g. Tagging, Firmware Update) are enabled on the widget. **Name**: bulkControlsEnabled **Type**: BOOLEAN \| Optional **Default Value**: *false* `[bulkControlsEnabled]="true"` |
| *Controls Enabled* | The boolean flag indicating whether controls (e.g. Search, Export) are enabled on the widget. **Name**: controlsEnabled **Type**: BOOLEAN \| Optional **Default Value**: *true* `[controlsEnabled]="false"` |
| *Details Path* | The optional path that identifies the details page to be opened when a row is clicked. **Name**: detailsPath **Type**: STRING \| Optional `detailsPath="abc"` |
| *Empty Message* | The blank message to be displayed in the widget in case no item was found. To manage translations, you can define a label and use the key as the value of the property. **Name**: emptyMessage **Type**: STRING \| Optional `emptyMessage="No customer found"` |
| *Initial Sorting* | The array of property names and criteria to use for sorting (e.g. ['name','asc','serialNumber','desc']). **Name**: sort **Type**: SORT_PROPERTIES \| Optional `[sort]="['name','asc','serialNumber','desc']"` |
| *Page Size* | The number of items to load on each page. **Name**: pageSize **Type**: INTEGER \| Optional **Default Value**: *50* `pageSize="100"` |
| *Query* | The array of conditions filtering out items. For instance: [query]='[{'property': 'connectionStatus', 'predicate': 'eq', 'value': '1'}]' Predicates: eq, beginsWith, like, notLike, isEmpty, isNotEmpty, gt, gte, lt, lte. **Name**: query **Type**: QUERY \| Optional **Predicates**: *beginsWith*, *eq*, *neq*, *gt*, *gte*, *isEmpty*, *isNotEmpty*, *lt*, *lte*, *like*, *notLike* `[query]="[{property:'prop1', predicate: 'eq', value: 'foo'}, {property:'prop2', predicate: 'in', value: ['bar', 'baz']}]"` |
| *Query Variable* | The id of the page's <things-filter-field> used for searching. **Name**: queryFieldRef **Type**: STRING \| Optional `queryFieldRef="query-1"` |
| *Search Fields* | The array of fields used to filter out the objects when searching by a generic key. For instance: [searchFields]='['name', 'serialNumber', 'customer.name', 'customer.code']' **Name**: searchFields **Type**: PROPERTY (multiple) \| Optional `[searchFields]="['prop1', 'prop2']"` |
| *Title* | The title displayed on the top part of the widget box. **Name**: title **Type**: STRING \| Optional `[title]="'Partners'"` |
| *Type* | **Name**: type **Type**: ENUM \| Optional **Values**: *CHANNEL*, *DATA_RECIPIENT* `type="CHANNEL"` |
| **Advanced** |
| *Id* | The id of the widget. **Name**: id **Type**: STRING \| Optional `id="abc"` |
| **Rendering** |
| *Availability* | Configure availability based on active features on Digital Plan on Add-ons **Name**: hasFeature **Type**: FEATURE (multiple) \| Optional `[hasFeature]="['feature_a', 'feature_b']"` |
| *CSS Class* | The name(s) of the CSS class used to customize the widget layout. **Name**: class **Type**: STRING \| Optional `class="my-custom-class"` |
| *Visibility Condition* | The expression that allows you to reduce the visibility of the element. **Name**: *ngIf **Type**: STRING \| Optional `*ngIf="getUser().organizationId != null"` |
| **Sub Elements** |
| [*Property*](/docs/partner-list-widget/#property) | The property whose label and current value must be rendered as a widget row. |
| [*Composite Part*](/docs/partner-list-widget/#composite-part) | The widget part combining multiple properties. |

#### Property `&lt;property&gt;`

| *Description* | The property description. **Name**: description **Type**: STRING \| Optional `description="abc"` |
| --- | --- |
| *Filter* | The name of the filter used to transform and display values. **Name**: filter **Type**: FILTER \| Optional `filter="fooBarFilter"` |
| *Label* | The property alternative label. **Name**: label **Type**: STRING \| Optional `label="Temperature"` |
| *Name* | The property whose value must be loaded by the widget. **Name**: name **Type**: PROPERTY \| Required `name="serialNumber"` |
| **Advanced** |
| *Column CSS Class* | The name(s) of the column CSS class used to customize the table column. **Name**: columnClass **Type**: COLUMN_CSS \| Optional `columnClass="my-column-custom-class"` |
| *Details Page Path* | The optional path that identifies the details page to be opened when a column value is clicked. **Name**: detailsPath **Type**: STRING \| Optional `detailsPath="abc"` |
| *Display Mode* | The way the column is displayed. **Name**: displayMode **Type**: ENUM \| Optional **Values**: *VISIBLE*, *INITIALLY_HIDDEN*, *ALWAYS_HIDDEN* **Default Value**: *VISIBLE* `displayMode="VISIBLE"` |
| *Include in Export* | The boolean flag indicating whether the property value should be included in the export even when not visible within the page. **Name**: includeInExport **Type**: BOOLEAN \| Optional **Default Value**: *false* `[includeInExport]="true"` |
| *Show Header* | The flag indicated whether the header is visible. **Name**: showHeader **Type**: BOOLEAN \| Optional **Default Value**: *true* `[showHeader]="false"` |
| *Visibility Condition* | The expression that allows you to reduce the visibility of the element. **Name**: *ngIf **Type**: STRING \| Optional `*ngIf="getUser().organizationId != null"` |

#### Composite Part `&lt;composite-part&gt;`

| *Description* | The composite-part description. **Name**: description **Type**: STRING \| Optional `description="abc"` |
| --- | --- |
| *Filter* | The filter applied on the composite-part to transform or display its value. **Name**: filter **Type**: FILTER \| Optional `filter="fooBarFilter"` |
| *Label* | The label displayed by the widget. **Name**: label **Type**: STRING \| Optional `label="abc"` |
| *Name* | The composite-part name. **Name**: name **Type**: STRING \| Optional `name="abc"` |
| *Sorting Criteria* | The comma seprated list of property names and criteria to use for sorting the list column associated to this composite-part (e.g. properties.p1,ASC,properties.p2,DESC). **Name**: sortingCriteria **Type**: STRING \| Optional `sortingCriteria="properties.p1,ASC,properties.p2,DESC"` |
| **Advanced** |
| *Column CSS Class* | The name(s) of the column CSS class used to customize the table column. **Name**: columnClass **Type**: COLUMN_CSS \| Optional `columnClass="my-column-custom-class"` |
| *Details Page Path* | The optional path that identifies the details page to be opened when a column value is clicked. **Name**: detailsPath **Type**: STRING \| Optional `detailsPath="abc"` |
| *Display Mode* | The way the column is displayed. **Name**: displayMode **Type**: ENUM \| Optional **Values**: *VISIBLE*, *INITIALLY_HIDDEN*, *ALWAYS_HIDDEN* **Default Value**: *VISIBLE* `displayMode="VISIBLE"` |
| *Show Header* | The flag indicated whether the header is visible. **Name**: showHeader **Type**: BOOLEAN \| Optional **Default Value**: *true* `[showHeader]="false"` |
| *Visibility Condition* | The expression that allows you to reduce the visibility of the element. **Name**: *ngIf **Type**: STRING \| Optional `*ngIf="getUser().organizationId != null"` |
| **Sub Elements** |
| [*Property*](/docs/partner-list-widget/#property) | The property whose value must be loaded within the composite-part. |

#### Property `&lt;property&gt;`

| *Name* | The property whose value must be loaded by the widget. **Name**: name **Type**: PROPERTY \| Required `name="serialNumber"` |
| --- | --- |

## Full Syntax Example

```xml

<partner-list-widget-v2    
    [title]="'Partners'"
    pageSize="100"
    [enableActions]="false"
    [controlsEnabled]="false"
    sort="['name','asc','serialNumber','desc']"
    query="[{property:'prop1', predicate: 'eq', value: 'foo'}, {property:'prop2', predicate: 'in', value: ['bar', 'baz']}]"
    searchFields="['prop1', 'prop2']"
    queryFieldRef="query-1"
    blockColumns="2"
    emptyMessage="No customer found"
    [bulkControlsEnabled]="true"
    detailsPath="abc"
    type="CHANNEL"
    id="abc"
    class="my-custom-class"
    *ngIf="getUser().organizationId != null"
    hasFeature="['feature_a', 'feature_b']">
    <property        
            name="serialNumber"
            label="Temperature"
            description="abc"
            filter="fooBarFilter"
            *ngIf="getUser().organizationId != null"
            [showHeader]="false"
            columnClass="my-column-custom-class"
            displayMode="VISIBLE"
            [includeInExport]="true"
            detailsPath="abc"></property>
    <composite-part        
            name="abc"
            label="abc"
            description="abc"
            filter="fooBarFilter"
            sortingCriteria="properties.p1,ASC,properties.p2,DESC"
            *ngIf="getUser().organizationId != null"
            [showHeader]="false"
            columnClass="my-column-custom-class"
            displayMode="VISIBLE"
            detailsPath="abc">
            <property            
                        name="serialNumber"></property>
    </composite-part>
</partner-list-widget-v2>
```