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

# List Customers

GET https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/customer/

List customers under your company, with optional search and pagination.

**Query parameters**

| Field      | Type    | Required | Notes                                                                                    |
| ---------- | ------- | -------- | ---------------------------------------------------------------------------------------- |
| `page`     | integer | no       | Default 1                                                                                |
| `pageSize` | integer | no       | Default 20, **capped at 20**                                                             |
| `search`   | string  | no       | Matches `email`, `firstName`, `lastName` (case-insensitive contains) or `bvn` (contains) |

**Behaviour notes**

* Each item has only `id`, `firstName` and `lastName`, newest first.
* The response envelope differs from the other endpoints: `success: true` (boolean) instead of `status: "success"`, and `meta.total` instead of `meta.totalItems`.
* Errors return `400 { "success": false, "message": "Server error" }`.

Reference: https://docs.shimi.cash/api-reference/shimi-api/customers/list-customers

## Authentication

- `Authorization` header (bearer token, required) — Access token from Generate Access Token (valid 15 minutes).

## Request

### Query parameters

- `page` (string, optional) — Optional. Defaults to 1.
- `pageSize` (string, optional) — Optional. Defaults to 20.
- `search` (string, optional) — Optional. Search term.

## Response

### 200

OK

- `success` (boolean, optional)
- `data` (list of CustomerGetResponsesContentApplicationJsonSchemaDataItems, optional)
- `meta` (CustomerGetResponsesContentApplicationJsonSchemaMeta, optional)

## Errors

### 400 Bad Request Error

Bad Request

- `success` (boolean, optional)
- `message` (string, optional)

### 401 Unauthorized Error

Unauthorized

- `message` (string, optional)

### 403 Forbidden Error

Invalid or expired access token / KYB not approved / Account deactivated

- `message` (string, optional)
- `code` (string, optional)
- `kybStatus` (string, optional)

## Types

### CustomerGetResponsesContentApplicationJsonSchemaDataItems

- `id` (string, optional)
- `firstName` (string, optional)
- `lastName` (string, optional)

### CustomerGetResponsesContentApplicationJsonSchemaMeta

- `page` (integer, optional)
- `pageSize` (integer, optional)
- `total` (integer, optional)
- `totalPages` (integer, optional)

## Examples

**Response**

```json
{
  "success": true,
  "data": [
    {
      "id": "cmg8x2k4p0001qz7h3n9d5v2a",
      "firstName": "Chiamaka",
      "lastName": "Okonkwo"
    },
    {
      "id": "cmg8y5t1m0004qz7hk2l8w3rb",
      "firstName": "Tunde",
      "lastName": "Adebayo"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 2,
    "totalPages": 1
  }
}
```

**SDK Code**

```python 200 Success
import requests

url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/customer/"

querystring = {"page":"1","pageSize":"20"}

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

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

print(response.json())
```

```javascript 200 Success
const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/customer/?page=1&pageSize=20';
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 200 Success
package main

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

func main() {

	url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/customer/?page=1&pageSize=20"

	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 200 Success
require 'uri'
require 'net/http'

url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/customer/?page=1&pageSize=20")

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 200 Success
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/customer/?page=1&pageSize=20")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/customer/?page=1&pageSize=20', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp 200 Success
using RestSharp;

var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/customer/?page=1&pageSize=20");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 Success
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/customer/?page=1&pageSize=20")! 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()
```