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

# List customers

GET https://www.your-store.co.il/api/v1/customers

The store's registered customers, newest first. Requires `customers:read`. Needs customer registration on in the store settings (409 `registration_disabled` otherwise).

Reference: https://docs.coi.co.il/customers/list-customers

## Authentication

- `Authorization` header (bearer token, required) — An API key from the store's admin: חנות > API ומפתחות. Send it as `Authorization: Bearer coi_sk_...` (or `X-Api-Key: coi_sk_...`). Never in the URL - `?apikey=` is refused with 400.

## Request

### Query parameters

- `limit` (integer, optional, default: 50) — Rows per page, 1 to 100.
- `cursor` (string, optional) — `nextCursor` from the previous page, as is. Omit for the first page.
- `email` (string, optional) — Find one customer by exact email.
- `created_since` (string, optional) — Only customers registered from then on. ISO 8601: `2026-09-27` or `2026-09-27T10:00:00+03:00`.

## Response

### 200

A page of customers.

- `ok` (true, optional)
- `data` (list of Customer, optional)
- `hasMore` (boolean, optional) — Whether there is another page.
- `nextCursor` (string, optional, nullable) — Pass as `cursor` for the next page; null on the last page.

## Errors

### 400 Bad Request Error

The request is not valid - a field of the wrong type, a missing field, a bad parameter.

- `ok` (false, optional)
- `error` (ErrorError, optional)

### 401 Unauthorized Error

Missing, invalid, revoked or expired API key. The same answer for all of them.

- `ok` (false, optional)
- `error` (ErrorError, optional)

### 403 Forbidden Error

The key lacks the permission (`insufficient_scope`), or the site's plan does not include the API (`plan_required`).

- `ok` (false, optional)
- `error` (ErrorError, optional)

### 429 Too Many Requests Error

More than 120 requests a minute with one key. Wait `Retry-After` seconds.

- `ok` (false, optional)
- `error` (ErrorError, optional)

## Types

### Customer

- `id` (integer, optional)
- `email` (string, optional)
- `firstName` (string, optional)
- `lastName` (string, optional)
- `phone` (string, optional, nullable)
- `newsletter` (boolean, optional)
- `status` (enum, optional) — `pending` = waiting for the owner's approval ("אשר לקוחות ידנית" is on and it never logged in).
  - Allowed values: `active`, `pending`, `locked`
- `notes` (string, optional, nullable)
- `registeredAt` (string, optional, nullable)
- `lastVisitAt` (string, optional, nullable)

### ErrorError

- `code` (string, optional) — Stable, machine-readable: `unauthorized`, `insufficient_scope`, `plan_required`, `invalid_field`, `invalid_parameter`, `invalid_json`, `json_required`, `not_found`, `method_not_allowed`, `nothing_to_update`, `plan_limit`, `email_taken`, `registration_disabled`, `rate_limited`, `too_many_failures`, `https_required`, `key_in_url`, `server_error`.
- `message` (string, optional) — What went wrong, in English, for a person.

## Examples

**Response**

```json
{
  "ok": true,
  "data": [
    {
      "id": 49,
      "email": "israel@example.com",
      "firstName": "ישראל",
      "lastName": "ישראלי",
      "phone": "0501234567",
      "newsletter": true,
      "status": "active",
      "notes": null,
      "registeredAt": "2026-05-04T20:10:00+03:00",
      "lastVisitAt": "2026-09-23T17:12:00+03:00"
    }
  ],
  "hasMore": true,
  "nextCursor": "aToxNjQ2"
}
```

**SDK Code**

```python
import requests

url = "https://www.your-store.co.il/api/v1/customers"

querystring = {"created_since":"2026-09-01"}

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://www.your-store.co.il/api/v1/customers?created_since=2026-09-01';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://www.your-store.co.il/api/v1/customers?created_since=2026-09-01"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://www.your-store.co.il/api/v1/customers?created_since=2026-09-01")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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://www.your-store.co.il/api/v1/customers?created_since=2026-09-01")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://www.your-store.co.il/api/v1/customers?created_since=2026-09-01', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://www.your-store.co.il/api/v1/customers?created_since=2026-09-01");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://www.your-store.co.il/api/v1/customers?created_since=2026-09-01")! 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()
```