> For the complete documentation index, see [llms.txt](https://bagelpay.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bagelpay.gitbook.io/docs/apireference/api-document/customer.md).

# Customer

## GET /api/customers/list

> List Customers

```json
{"openapi":"3.1.0","info":{"title":"BagelPay-SDK","version":"1.0.0"},"tags":[{"name":"Customer"}],"servers":[{"url":"https://test.bagelpay.io","description":"Development env"}],"security":[],"paths":{"/api/customers/list":{"get":{"summary":"List Customers","deprecated":false,"description":"","tags":["Customer"],"parameters":[{"name":"pageNum","in":"query","description":"","required":false,"schema":{"type":"integer","minimum":1}},{"name":"pageSize","in":"query","description":"","required":false,"schema":{"type":"integer","minimum":1}},{"name":"x-api-key","in":"header","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"email":{"type":"string"},"remark":{"type":["string","null"]},"subscriptions":{"type":"integer"},"payments":{"type":"integer"},"store_id":{"type":"string"},"total_spend":{"type":"integer"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"code":{"type":"integer"},"msg":{"type":"string"}},"required":["total","items","code","msg"]}}},"headers":{}}}}}}}
```