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

# roark customer list

> List customers

Returns the people who have talked to your agents in this project. Customers we hold nothing about beyond their identifier are left out unless includeNoData is true.

```bash Synopsis theme={"theme":{"light":"everforest-light","dark":"everforest-dark"}}
roark customer list [options]
```

> [!NOTE]
>
> Calls `GET /v1/customer`

## Options

**--limit** `integer`

**--page** `integer`

**--search** `string`

**--agent-id** `string`

**--modality** `string`

One of `call`, `chat`

**--include-no-data** `string`

Include customers we hold nothing about beyond their identifier. Defaults to false. One of `true`, `false`

**--sort-by** `string`

lastSeenAt (the default), firstSeenAt, conversationCount, voiceCount, chatCount, talkTimeMs or displayName, or field.\<key> (for example field.COMPANY) to sort by a field's value. Field keys come from GET /v1/customer/fields. Customers without a value sort last.

**--sort-direction** `string`

One of `asc`, `desc`

**--field-key** `string`

Filter by this field, a key from GET /v1/customer/fields. Use with fieldOperator and, unless checking presence, fieldValue.

**--field-operator** `string`

How fieldValue is compared, ignoring case. `NOT_EQUALS` includes customers without the field. One of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, `STARTS_WITH`, `IS_SET`, `IS_NOT_SET`

**--field-value** `string`

## Example

```bash theme={"theme":{"light":"everforest-light","dark":"everforest-dark"}}
roark customer list
```

Every command also takes the [global options](https://docs.roark.ai/cli-reference/overview.md#global-options) and sets one
of the [exit codes](https://docs.roark.ai/cli-reference/overview.md#exit-codes).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.