## List customers

`$ straddle customers list`

**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

- `--created-from: optional string`

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

- `--created-to: optional string`

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

- `--email: optional string`

  Query param: Filter customers by `email` address.

- `--external-id: optional string`

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

- `--name: optional string`

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

- `--page-number: optional number`

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

- `--page-size: optional number`

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

- `--search-text: optional string`

  Query param: General search term to filter customers.

- `--sort-by: optional "name" or "created_at"`

  Query param

- `--sort-order: optional "asc" or "desc"`

  Query param

- `--status: optional array of "pending" or "review" or "verified" or 2 more`

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

- `--type: optional array of "individual" or "business"`

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

- `--correlation-id: optional string`

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

- `--request-id: optional string`

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

- `--straddle-account-id: optional string`

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

### Returns

- `customerSummaryPagedV1: object { data, meta, response_type }`

  - `data: array of object { id, created_at, email, 6 more }`

    - `id: string`

      Unique identifier for the customer.

    - `created_at: string`

      Timestamp of when the customer record was created.

    - `email: string`

      The customer's email address.

    - `name: string`

      Full name of the individual or business name.

    - `phone: string`

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

    - `status: "pending" or "review" or "verified" or 2 more`

      - `"pending"`

      - `"review"`

      - `"verified"`

      - `"inactive"`

      - `"rejected"`

    - `type: "individual" or "business"`

      - `"individual"`

      - `"business"`

    - `updated_at: string`

      Timestamp of the most recent update to the customer record.

    - `external_id: optional string`

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

  - `meta: object { api_request_id, api_request_timestamp, max_page_size, 6 more }`

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

    - `max_page_size: number`

      Maximum allowed page size for this endpoint.

    - `page_number: number`

      Page number for paginated results.

    - `page_size: number`

      Number of items per page in this response.

    - `sort_by: string`

      The field that the results were sorted by.

    - `sort_order: "asc" or "desc"`

      - `"asc"`

      - `"desc"`

    - `total_items: number`

    - `total_pages: number`

      The number of pages available.

  - `response_type: "object" or "array" or "error" or "none"`

    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"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```cli
straddle customers list \
  --api-key 'My API Key'
```

#### 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"
}
```