# Query list of customers with store credits balance

### GET: /wp-json/wc-store-credits/v1/customers

{% tabs %}
{% tab title="Request" %}
**Requirements:**

* Logged-in user
* user role with `manage_woocommerce` user capability

<table data-header-hidden><thead><tr><th width="150">Method</th><th>Endpoint</th></tr></thead><tbody><tr><td>Method</td><td>Endpoint</td></tr><tr><td>GET</td><td>/wp-json/wc-store-credits/v1/customers</td></tr></tbody></table>

| Query Parameters | Required | Type    | Default value | Description                                                         |
| ---------------- | -------- | ------- | ------------- | ------------------------------------------------------------------- |
| page             | no       | integer | 1             | Current page to load in query.                                      |
| per\_page        | no       | integer | 10            | Number of entries to load per page in query.                        |
| search           | no       | string  | -             | Search info related to customers: name, email, phone number, etc.   |
| sort\_by         | no       | string  | date          | Value to be based for sorting: `user_id`, `date`, `type`, `action`. |
| sort\_order      | no       | string  | desc          | Order of sorting: `desc` or `asc`                                   |
| {% endtab %}     |          |         |               |                                                                     |

{% tab title="Request Example" %}
Query store credit customers

```
GET: http://example.com/wp-json/wc-store-credits/v1/customers
```

Query store credit customers with search

```
GET: http://example.com/wp-json/wc-store-credits/v1/customers?search=test
```

{% endtab %}

{% tab title="Response Example" %}
**Status: 200 OK**

```
Headers:
{
...
X-TOTAL: 20
}

[
  {
    "key": "9",
    "id": 9,
    "first_name": "Indo",
    "last_name": "Nesia",
    "email": "indonesia@acfw.test",
    "balance_raw": 55,
    "balance": "$55.00"
  },
  {
    "key": "5",
    "id": 5,
    "first_name": "",
    "last_name": "",
    "email": "dummy3@acfw.test",
    "balance_raw": 95.5,
    "balance": "$95.50"
  },
  {
    "key": "4",
    "id": 4,
    "first_name": "",
    "last_name": "",
    "email": "dummy2@acfw.test",
    "balance_raw": 0,
    "balance": "$0.00"
  },
  ...
]
```

**Status: 401 Unauthorized**

```
{
    "code": "rest_forbidden_context",
    "message": "Sorry, you are not allowed access to this endpoint.",
    "data": {
        "status": 401
    }
}
```

{% endtab %}
{% endtabs %}

###