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

# List

GET /api/v1/customers

Reference: https://docs.perkss.io/api-reference/perkss-partner-api/customers/list

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: v1
  version: 1.0.0
paths:
  /api/v1/customers:
    get:
      operationId: list
      summary: List
      tags:
        - customers
      parameters:
        - name: page
          in: query
          description: 1-based page number. Defaults to 1.
          required: false
          schema:
            type: string
        - name: pageSize
          in: query
          description: Rows per page. Defaults to 20, capped at 100.
          required: false
          schema:
            type: string
        - name: externalId
          in: query
          description: >-
            Exact match on your own identifier for the customer — returns 0 or 1
            rows (the alias is unique within your company).
          required: false
          schema:
            type: string
        - name: email
          in: query
          description: >-
            Exact email match. Email is NOT a customer identity — every customer
            sharing the address returns.
          required: false
          schema:
            type: string
        - name: phone
          in: query
          description: >-
            Phone in any parseable format; canonicalized to E.164 before
            matching. A malformed value returns 400.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: Bearer authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customers_list_Response_200'
components:
  schemas:
    Customers_list_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: Customers_list_Response_200
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/api/v1/customers"

querystring = {"email":"ada@example.com","externalId":"crm-8842","page":"1","pageSize":"20","phone":"+34600000000"}

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.example.com/api/v1/customers?email=ada%40example.com&externalId=crm-8842&page=1&pageSize=20&phone=%2B34600000000';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/customers?email=ada%40example.com&externalId=crm-8842&page=1&pageSize=20&phone=%2B34600000000"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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.example.com/api/v1/customers?email=ada%40example.com&externalId=crm-8842&page=1&pageSize=20&phone=%2B34600000000")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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.example.com/api/v1/customers?email=ada%40example.com&externalId=crm-8842&page=1&pageSize=20&phone=%2B34600000000")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/api/v1/customers?email=ada%40example.com&externalId=crm-8842&page=1&pageSize=20&phone=%2B34600000000', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/api/v1/customers?email=ada%40example.com&externalId=crm-8842&page=1&pageSize=20&phone=%2B34600000000");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/api/v1/customers?email=ada%40example.com&externalId=crm-8842&page=1&pageSize=20&phone=%2B34600000000")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```