GET
/
v1
/
customers
Get All Customers
curl --request GET \
  --url https://api.sandbox.hit-pay.com/v1/customers \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "birth_date": "<string>",
      "gender": "<string>",
      "email": "<string>",
      "phone_number": "<string>",
      "address": {
        "city": "<string>",
        "state": "<string>",
        "street": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "remark": "<string>",
      "phone_number_country_code": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "links": {
    "first": "<any>",
    "last": "<any>",
    "prev": "<any>",
    "next": "<string>"
  },
  "meta": {
    "path": "<string>",
    "per_page": 123,
    "next_cursor": "<string>",
    "prev_cursor": "<any>"
  }
}

Headers

​
X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Query Parameters

​
page
number
default:1
​
per_page
number
default:10

Response

200 - application/json

200

The response is of type object.