Customers

Get All Invoice Customers

GET
/api/v1/customers
AuthorizationBearer <token>

In: header

Query Parameters

page?number
limit?number
sort?string
searchTerm?string

Search customer invoice details

Response Body

application/json

curl -X GET "https://example.com/api/v1/customers"
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "businessId": "f3f3c6a1-45e3-44aa-b05a-1fbe98d52d09",
    "reference": "CUST_INV_ABC123XYZ456",
    "modules": [
      "invoice"
    ],
    "firstName": "John",
    "lastName": "Doe",
    "email": "customer@example.com",
    "phone": "+2348098765432",
    "tin": "98765432-0001",
    "country": "Nigeria",
    "state": "Lagos",
    "city": "Yaba",
    "address": "456 Market Street, Yaba",
    "postcode": "023401",
    "createdAt": "2024-01-23T10:00:00.000Z",
    "updatedAt": "2024-01-23T10:00:00.000Z"
  }
]
Empty
Empty
Empty

How is this guide?

Last updated on