## List

`v1.customers.list(**kwargs) -> CursorPage<CustomerDetail>`

**get** `/v1/customers`

List all customers.

### Parameters

- **customer\_ids:** `Array[String]`

  Filter the customer list by customer_id.  Up to 100 ids can be provided.

- **ingest\_alias:** `String`

  Filter the customer list by ingest_alias

- **limit:** `Integer`

  Max number of results that should be returned

- **next\_page:** `String`

  Cursor that indicates where the next page of results should start.

- **only\_archived:** `bool`

  Filter the customer list to only return archived customers. By default, only active customers are returned.

- **salesforce\_account\_ids:** `Array[String]`

  Filter the customer list by salesforce_account_id.  Up to 100 ids can be provided.

### Returns

- `CustomerDetail`

### Example

```ruby
require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

page = metronome.v1.customers.list

puts(page)
```