> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.tiankii.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.tiankii.com/_mcp/server.

# List customers

GET https://api.md.tiankii.com/v1/customers

## List customers

Returns a paginated list of customers belonging to the authenticated merchant's store. Results are always scoped to the caller's `storeId`.

### Authentication
- Send the merchant API key in the **`x-api-key`** header (alias `x-account-api-key`).
- Requires the scope: **`Merchant.customer.read`**.
- Optionally scope the key to a specific store/account with **`x-application-account-id`** (alias `x-account-id`) or the `application_account_id` / `account_id` query param.

### Query params
- Pagination: `page` (default 1) and `per_page` (default 10). Set `per_page=0` to return **all** records (no pagination).
- `name` / `email`: partial, case-insensitive `contains` filters applied to the respective columns.
- `filter`: generic multi-field search across `name`, `email`, `mobile` (Prisma where fragment produced by the `@Filter` decorator).
- `sort`: ordering over `createdAt`, `name`, `email` (Prisma orderBy produced by the `@Sort` decorator).
- `sorter`: JSON-encoded ordering object (allowed keys: `createdAt`, `name`, `email`, each `asc` or `desc`). When provided it overrides `sort`.

### Response
Envelope with `_metadata` (page, per_page, total_page, total_count) and a `records` array of customer objects.

---
**Notas:** Results are always filtered to the authenticated store's storeId. per_page=0 disables pagination (returns everything; _metadata.per_page then equals total_count). The `sorter` JSON param, when supplied, takes precedence over `sort`. start_at/end_at date filters are NOT part of this DTO (FilterCustomerDto extends PaginationDto, not FilterDateDto).

Reference: https://docs.tiankii.com/api-reference/tiankii-api-api-key/customers/list

## Authentication

- `x-api-key` header (required)

## Request

### Query parameters

- `page` (integer, optional, default: 1) — Page number to return.
- `per_page` (integer, optional, default: 10) — Number of records per page.
- `name` (string, optional) — Case-insensitive partial match on the customer name.
- `email` (string, optional) — Case-insensitive partial match on the customer email.
- `filter` (string, optional) — Filter with the query language. Accepts a string expression or a URL-encoded JSON object following Prisma's `where` clause. **Allowed fields:** `name`, `email`, `mobile` **Allowed operators:** `equals`, `not`, `in`, `notIn`, `lt`, `lte`, `gt`, `gte`, `contains`, `startsWith`, `endsWith`, `like` **String format:** `field:operator:value`, comma-separated. The operator defaults to `equals` (`field:value`), and `|` works as a separator. Group with `AND(...)` or `OR(...)` — `AND` is the default. **JSON format:** `{"OR":[{"name":{"contains":"Jane"}}]}`
- `sort` (string, optional) — Sort by one or more fields, comma-separated. **Allowed fields:** `createdAt`, `name`, `email` **Formats:** `field` (ascending by default), `+field`, `-field`, `field:asc`, `field:desc` (`|` also works as the separator).
- `sorter` (string, optional) — Alternative to `sort`: a JSON string mapping a field to a direction (`asc` / `desc`). **Allowed fields:** `createdAt`, `name`, `email`

### Headers

- `x-application-account-id` (string, optional) — Scope the request to a specific store / account instead of the one resolved from the API key. Aliases: the `x-account-id` header, or the `application_account_id` / `account_id` query parameter.

## Examples

**SDK Code**

```python
import requests

url = "https://api.md.tiankii.com/v1/customers"

querystring = {"email":"jane@example.com","filter":"AND(name:contains:jane,email:endsWith:@example.com)","name":"jane","sort":"-createdAt","sorter":"{\"createdAt\":\"desc\"}"}

headers = {
    "x-application-account-id": "acct_3f9a21c7",
    "x-api-key": "<apiKey>"
}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.md.tiankii.com/v1/customers?email=jane%40example.com&filter=AND%28name%3Acontains%3Ajane%2Cemail%3AendsWith%3A%40example.com%29&name=jane&sort=-createdAt&sorter=%7B%22createdAt%22%3A%22desc%22%7D';
const options = {
  method: 'GET',
  headers: {'x-application-account-id': 'acct_3f9a21c7', 'x-api-key': '<apiKey>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.md.tiankii.com/v1/customers?email=jane%40example.com&filter=AND%28name%3Acontains%3Ajane%2Cemail%3AendsWith%3A%40example.com%29&name=jane&sort=-createdAt&sorter=%7B%22createdAt%22%3A%22desc%22%7D"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-application-account-id", "acct_3f9a21c7")
	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.md.tiankii.com/v1/customers?email=jane%40example.com&filter=AND%28name%3Acontains%3Ajane%2Cemail%3AendsWith%3A%40example.com%29&name=jane&sort=-createdAt&sorter=%7B%22createdAt%22%3A%22desc%22%7D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-application-account-id"] = 'acct_3f9a21c7'
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.md.tiankii.com/v1/customers?email=jane%40example.com&filter=AND%28name%3Acontains%3Ajane%2Cemail%3AendsWith%3A%40example.com%29&name=jane&sort=-createdAt&sorter=%7B%22createdAt%22%3A%22desc%22%7D")
  .header("x-application-account-id", "acct_3f9a21c7")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.md.tiankii.com/v1/customers?email=jane%40example.com&filter=AND%28name%3Acontains%3Ajane%2Cemail%3AendsWith%3A%40example.com%29&name=jane&sort=-createdAt&sorter=%7B%22createdAt%22%3A%22desc%22%7D', [
  'headers' => [
    'x-api-key' => '<apiKey>',
    'x-application-account-id' => 'acct_3f9a21c7',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.md.tiankii.com/v1/customers?email=jane%40example.com&filter=AND%28name%3Acontains%3Ajane%2Cemail%3AendsWith%3A%40example.com%29&name=jane&sort=-createdAt&sorter=%7B%22createdAt%22%3A%22desc%22%7D");
var request = new RestRequest(Method.GET);
request.AddHeader("x-application-account-id", "acct_3f9a21c7");
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-application-account-id": "acct_3f9a21c7",
  "x-api-key": "<apiKey>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.md.tiankii.com/v1/customers?email=jane%40example.com&filter=AND%28name%3Acontains%3Ajane%2Cemail%3AendsWith%3A%40example.com%29&name=jane&sort=-createdAt&sorter=%7B%22createdAt%22%3A%22desc%22%7D")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```