## List

`client.v1.customers.list(CustomerListParamsquery?, RequestOptionsoptions?): CursorPage<CustomerDetail>`

**get** `/v1/customers`

List all customers.

### Parameters

- **query:** `CustomerListParams`

  - **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:** `number`

    Max number of results that should be returned

  - **next\_page:** `string`

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

  - **only\_archived:** `boolean`

    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

```node
import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

// Automatically fetches more pages as needed.
for await (const customerDetail of client.v1.customers.list()) {
  console.log(customerDetail.id);
}
```