## List

`client.V1.Customers.List(ctx, query) (*CursorPage[CustomerDetail], error)`

**get** `/v1/customers`

List all customers.

### Parameters

- **query:** `V1CustomerListParams`

  - **CustomerIDs:** `param.Field[[]string]`

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

  - **IngestAlias:** `param.Field[string]`

    Filter the customer list by ingest_alias

  - **Limit:** `param.Field[int64]`

    Max number of results that should be returned

  - **NextPage:** `param.Field[string]`

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

  - **OnlyArchived:** `param.Field[bool]`

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

  - **SalesforceAccountIDs:** `param.Field[[]string]`

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

### Returns

- `CustomerDetail`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  page, err := client.V1.Customers.List(context.TODO(), metronome.V1CustomerListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
```