---
title: "Action custom_modules_list"
description: "Returns unique values of a custom module field for lists and dropdowns."
---

# Action `custom_modules_list`

> **System ID:** `action_custom_modules_list`

## Description

Retrieves unique values of the selected field from a custom module (along with record IDs) and builds a list object for the UI: dropdowns, autocomplete, and similar. You can filter records and limit the number of items.

## Events (scenario branches)

No branch events. The action returns a **list object** (not a branch name):

```json
{
  "total": 0,
  "value": null,
  "list": []
}
```

Each `list` item usually contains `id`, `text`, `value`. If the module or field is not set / an error occurred — an empty object with `total: 0` is returned.

## Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `module_name` | string | yes | — | Custom module alias (name). `model` is also accepted |
| `field` | string | yes | — | Field to take unique values from |
| `bot_id` | number | no | current bot | Bot ID for the module |
| `filters` | object | no | `null` | Record filters (merged with fields from user constants) |
| `limit` | number | no | `50` | Maximum items. `0` — no limit |

## Configuration example

```json
{
  "module_name": "product",
  "field": "category",
  "filters": {
    "status": "active"
  },
  "limit": 50
}
```

## Related docs

- [Actions reference](/en/actionjail/reference/actions-reference.md)