GET
/
customers
List all customers
curl --request GET \
  --url https://api.notchpay.co/customers \
  --header 'Authorization: <api-key>'
{
  "code": 200,
  "status": "OK",
  "message": "Customers retrieved",
  "totals": 25,
  "last_page": 1,
  "current_page": 1,
  "selected": 25,
  "items": [
    {
      "id": "cus_123456789",
      "name": "John Doe",
      "email": "john@example.com",
      "phone": 237600000000,
      "company_name": "ACME Inc",
      "address": {
        "country": "CM",
        "city": "Douala",
        "address_line1": "123 Main St"
      },
      "created_at": "2023-01-01T12:00:00.000Z",
      "updated_at": "2023-01-02T12:00:00.000Z",
      "blocked": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
limit
integer
default:30

Number of items per page

​
page
integer
default:1

Page number

​
search
string

Search by name, email, or phone

Response

Successful response

​
code
integer
required
Example:

200

​
status
string
required
Example:

"OK"

​
message
string
required
Example:

"Customers retrieved"

​
items
any[]
required
​
totals
integer
Example:

25

​
last_page
integer
Example:

1

​
current_page
integer
Example:

1

​
selected
integer
Example:

25