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

# Type Alias: ListSourcesParams

> **ListSourcesParams** = `object`

## Properties

### fields?

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

Fields to be retrieved as a result.

***

### id?

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

Filter by unique IDs.

***

### page?

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

Page number of result dataset records. offset = (page*size)

***

### q?

> `optional` **q**: `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`

Size count of records on result page. limit = (size++)

***

### sort?

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

Sort the result according to fields.

***

### type?

> `optional` **type**: [`ListSourcesTypeItem`](../wiki/_models.ListSourcesTypeItem.html)[]

Filter by source type.

- TYPE_UNSPECIFIED: Unspecified source type.
- CALL: Phone call source type.
- CHAT: Chat source type.
- SOCIAL_MEDIA: Social media source type.
- EMAIL: Email source type.
- API: API source type.
- MANUAL: Manual source type.