[@webitel/api-services](../index.html) / [\_models](../modules/_models.html) / ListCatalogsParams

# Type Alias: ListCatalogsParams

> **ListCatalogsParams** = `object`

Generated by orval v7.9.0 🍺
Do not edit manually.
service.proto
OpenAPI spec version: version not set

## Properties

### depth?

> `optional` **depth**: `string`

Filter by the depth of the hierarchy to retrieve services.
The depth indicates how many ancestor levels of services
will be included for each catalog.
- A depth of 0 includes only the direct catalog.
- A depth of 1 includes the catalog and its immediate services.
- By default the depth is limited by 3,
 meaning all nested services and sub-services will be included.

***

### fields?

> `optional` **fields**: `string`[]

Fields to be retrieved as a result.
If the user passes "-" as the value for fields,
it will retrieve all available fields for each catalog.

***

### hasSubservices?

> `optional` **hasSubservices**: `boolean`

Filter catalogs with subservices

***

### id?

> `optional` **id**: `string`[]

List of IDs to filter the catalogs

***

### page?

> `optional` **page**: `number`

Page number for pagination

***

### query?

> `optional` **query**: `string`

Search query string for filtering by name. Supports:
- Wildcards (*) for substring matching
- Placeholder (?) for single character substitution
- Exact match for full names

***

### size?

> `optional` **size**: `number`

Number of records per page

***

### sort?

> `optional` **sort**: `string`

Sorting options by fields

***

### state?

> `optional` **state**: `boolean`

Filter by state (true for active, false for inactive)

***

### subFields?

> `optional` **subFields**: `string`[]

Fields to be retrieved as a result for [SUBSERVICES].
If the user passes "-" as the value for fields,
it will retrieve all available fields for each catalog subservices.