## List customers

`CustomerSummaryPagedV1 Customers.List(CustomerListParams?parameters, CancellationTokencancellationToken = default)`

**get** `/v1/customers`

Lists or searches customers connected to your account. All supported query parameters are optional. If none are provided, the response will include all customers connected to your account. This endpoint supports advanced sorting and filtering options.

### Parameters

- `CustomerListParams parameters`

  - `DateTimeOffset createdFrom`

    Query param: Start date for filtering by `created_at` date.

  - `DateTimeOffset createdTo`

    Query param: End date for filtering by `created_at` date.

  - `string email`

    Query param: Filter customers by `email` address.

  - `string externalID`

    Query param: Filter by your system's `external_id`.

  - `string name`

    Query param: Filter customers by `name` (partial match).

  - `Int pageNumber`

    Query param: Page number for paginated results. Starts at 1.

  - `Int pageSize`

    Query param: Number of results per page. Maximum: 1000.

  - `string searchText`

    Query param: General search term to filter customers.

  - `SortBy sortBy`

    Query param

    - `"name"Name`

    - `"created_at"CreatedAt`

  - `SortOrder sortOrder`

    Query param

    - `"asc"Asc`

    - `"desc"Desc`

  - `IReadOnlyList<Status> status`

    Query param: Filter customers by their current `status`.

    - `"pending"Pending`

    - `"review"Review`

    - `"verified"Verified`

    - `"inactive"Inactive`

    - `"rejected"Rejected`

  - `IReadOnlyList<Type> types`

    Query param: Filter by customer type `individual` or `business`.

    - `"individual"Individual`

    - `"business"Business`

  - `string correlationID`

    Header param: Optional client generated identifier to trace and debug a series of requests.

  - `string requestID`

    Header param: Optional client generated identifier to trace and debug a request.

  - `string straddleAccountID`

    Header param: For use by platforms to specify an `account_id` to set the scope of a request.

### Returns

- `class CustomerSummaryPagedV1:`

  - `required IReadOnlyList<Data> Data`

    - `required string ID`

      Unique identifier for the customer.

    - `required DateTimeOffset CreatedAt`

      Timestamp of when the customer record was created.

    - `required string Email`

      The customer's email address.

    - `required string Name`

      Full name of the individual or business name.

    - `required string Phone`

      The customer's phone number in E.164 format.

    - `required Status Status`

      - `"pending"Pending`

      - `"review"Review`

      - `"verified"Verified`

      - `"inactive"Inactive`

      - `"rejected"Rejected`

    - `required Type Type`

      - `"individual"Individual`

      - `"business"Business`

    - `required DateTimeOffset UpdatedAt`

      Timestamp of the most recent update to the customer record.

    - `string? ExternalID`

      Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

  - `required Meta Meta`

    - `required string ApiRequestID`

      Unique identifier for this API request, useful for troubleshooting.

    - `required DateTimeOffset ApiRequestTimestamp`

      Timestamp for this API request, useful for troubleshooting.

    - `required Int MaxPageSize`

      Maximum allowed page size for this endpoint.

    - `required Int PageNumber`

      Page number for paginated results.

    - `required Int PageSize`

      Number of items per page in this response.

    - `required string SortBy`

      The field that the results were sorted by.

    - `required SortOrder SortOrder`

      - `"asc"Asc`

      - `"desc"Desc`

    - `required Int TotalItems`

    - `required Int TotalPages`

      The number of pages available.

  - `required ResponseType ResponseType`

    Indicates the structure of the returned content.

    - "object" means the `data` field contains a single JSON object.
    - "array" means the `data` field contains an array of objects.
    - "error" means the `data` field contains an error object with details of the issue.
    - "none" means no data is returned.

    - `"object"Object`

    - `"array"Array`

    - `"error"Error`

    - `"none"None`

### Example

```csharp
CustomerListParams parameters = new();

var page = await client.Customers.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}
```

#### Response

```json
{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "email": "dev@stainless.com",
      "name": "name",
      "phone": "+46991022",
      "status": "pending",
      "type": "individual",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "external_id": "external_id"
    }
  ],
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z",
    "max_page_size": 0,
    "page_number": 0,
    "page_size": 0,
    "sort_by": "sort_by",
    "sort_order": "asc",
    "total_items": 0,
    "total_pages": 0
  },
  "response_type": "object"
}
```