---
search:
  tags:
    - Customers
    - GET
seo:
  description: >-
    Any signed in user. Returns a page of customers ordered by name together
    with the… Reference for the GET /api/v1/customers endpoint in the PharmaFlow
    API.
sidebar:
  label: List customers
  badge: GET
title: List customers
type: openapi-operation
---
Any signed in user. Returns a page of customers ordered by name together with the total. search matches a name or phone substring or a national id exactly, with page and page_size.

`GET /api/v1/customers`

**Responses**

- `200` — A page of customers
- `401` — Not authenticated

Response example, 200:

```json
{
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991,
  "items": [
    {
      "id": "string",
      "name": "string",
      "phone": "string",
      "national_id": "string",
      "notes": "string",
      "image_url": "string",
      "credit_limit": "string",
      "current_balance": "string",
      "is_credit_allowed": true,
      "created_at": "string",
      "updated_at": "string",
      "is_deleted": true
    }
  ]
}
```