GET
/
customers
curl --request GET \
  --url https://api-staging.stablestack.xyz/api/customers \
  --header 'x-api-key: <x-api-key>'
{
  "status": "success",
  "data": [
    {
      "id": "10f07c0c-98d2-4f36-a9df-0dc75f747c52",
      "customer_type": "individual",
      "email": "olajohn3@gmail.com",
      "phone": "+2348918945668",
      "created_at": "2025-05-09T14:59:51.229Z",
      "updated_at": "2025-05-09T14:59:51.229Z",
      "status": "active",
      "address": {
        "line_1": "123 Main St",
        "line_2": "Suite 456",
        "city": "Lagos",
        "state": "Lagos",
        "postal_code": "214578",
        "country": "Nigeria"
      },
      "personal_info": {
        "first_name": "john",
        "middle_name": "Oluwaseun",
        "last_name": "ola",
        "birth_date": "1990-01-14T23:00:00.000Z"
      },
      "financial_info": {
        "account_purpose": "personal savings",
        "employment_status": "employed",
        "expected_monthly_income": "500000.00",
        "most_recent_occupation": "Software Engineer",
        "source_of_funds": "salary"
      }
    },
    {
      "id": "62217f2f-2f65-4aca-b613-9bcefa333af3",
      "customer_type": "business",
      "email": "contact@example.com",
      "phone": "+2347918945668",
      "created_at": "2025-05-09T14:58:35.745Z",
      "updated_at": "2025-05-09T14:58:35.745Z",
      "status": "active",
      "address": {
        "line_1": "123 Business Ave",
        "line_2": "Suite 456",
        "city": "Lagos",
        "state": "Lagos",
        "postal_code": "214578",
        "country": "Nigeria"
      },
      "personal_info": {
        "first_name": null,
        "middle_name": null,
        "last_name": null,
        "birth_date": null
      },
      "financial_info": {
        "account_purpose": "business operations",
        "employment_status": null,
        "expected_monthly_income": "5000000.00",
        "most_recent_occupation": null,
        "source_of_funds": "business revenue"
      },
      "business_info": {
        "business_name": "Example Enterprises",
        "business_type": "Retail",
        "business_website": "https://example.com"
      }
    },
    {
      "id": "85b148ab-3f6b-4d55-917f-3c8de668a48e",
      "customer_type": "business",
      "email": "contact@akande.com",
      "phone": "+2348098765432",
      "created_at": "2025-05-01T13:47:10.689Z",
      "updated_at": "2025-05-09T14:57:30.534Z",
      "status": "active",
      "address": {
        "line_1": "789 Business Avenue",
        "line_2": "Suite 500",
        "city": "Lagos",
        "state": "Lagos",
        "postal_code": "100001",
        "country": "Nigeria"
      },
      "personal_info": {
        "first_name": null,
        "middle_name": null,
        "last_name": null,
        "birth_date": null
      },
      "financial_info": {
        "account_purpose": "business operations",
        "employment_status": null,
        "expected_monthly_income": "5000000.00",
        "most_recent_occupation": null,
        "source_of_funds": "business revenue"
      },
      "business_info": {
        "business_name": "Acme Inc.",
        "business_type": "Technology Solutions",
        "business_website": "https://acme.example.com"
      }
    },
    {
      "id": "3836c9c3-0f62-4229-acaf-1da597a14991",
      "customer_type": "individual",
      "email": "johnDoe23@gmail.com",
      "phone": "+2348098765432",
      "created_at": "2025-05-01T13:45:30.837Z",
      "updated_at": "2025-05-09T14:55:58.657Z",
      "status": "active",
      "address": {
        "line_1": "456 Updated Street",
        "line_2": "Apt 101",
        "city": "Lagos",
        "state": "Lagos",
        "postal_code": "100001",
        "country": "Nigeria"
      },
      "personal_info": {
        "first_name": "John",
        "middle_name": "Michael",
        "last_name": "Doe",
        "birth_date": "1990-01-14T23:00:00.000Z"
      },
      "financial_info": {
        "account_purpose": "personal savings",
        "employment_status": "employed",
        "expected_monthly_income": "500000.00",
        "most_recent_occupation": "Software Engineer",
        "source_of_funds": "salary"
      }
    },
    {
      "id": "d75521df-4e59-48d4-938e-617e07c536b2",
      "customer_type": "individual",
      "email": "johnDoe0@gmail.com",
      "phone": "+2348918945660",
      "created_at": "2025-04-29T08:15:52.097Z",
      "updated_at": "2025-04-29T08:15:52.097Z",
      "status": "closed",
      "address": {
        "line_1": "123 Main St",
        "line_2": null,
        "city": "Lagos",
        "state": "Lagos",
        "postal_code": null,
        "country": "Nigeria"
      },
      "personal_info": {
        "first_name": "John",
        "middle_name": null,
        "last_name": "Doe",
        "birth_date": "1990-01-14T23:00:00.000Z"
      },
      "financial_info": {
        "account_purpose": "Personal savings",
        "employment_status": "Employed",
        "expected_monthly_income": null,
        "most_recent_occupation": null,
        "source_of_funds": null
      }
    },
    {
      "id": "33b60774-a9f0-48b8-be8d-c3d498782425",
      "customer_type": "business",
      "email": "johnDoe3@gmail.com",
      "phone": "+2348098765432",
      "created_at": "2025-04-24T23:52:31.714Z",
      "updated_at": "2025-04-29T08:17:00.668Z",
      "status": "active",
      "address": {
        "line_1": "123 Main St",
        "line_2": "456 Updated Address St",
        "city": "Lagos",
        "state": "Lagos",
        "postal_code": null,
        "country": "Nigeria"
      },
      "personal_info": {
        "first_name": "John",
        "middle_name": null,
        "last_name": "Doe",
        "birth_date": "1990-01-14T23:00:00.000Z"
      },
      "financial_info": {
        "account_purpose": "Personal savings",
        "employment_status": "Employed",
        "expected_monthly_income": null,
        "most_recent_occupation": null,
        "source_of_funds": null
      },
      "business_info": {
        "business_name": null,
        "business_type": null,
        "business_website": null
      }
    }
  ],
  "pagination": {
    "total": 6,
    "page": 1,
    "limit": 10,
    "totalPages": 1
  }
}

Retrieves a list of all customers associated with your merchant account.

Headers

x-api-key
string
required

Query Parameters

customer_type
enum<string>
Available options:
individual,
business
start_date
string
end_date
string
include_documents
boolean
page
integer
limit
integer

Response

200 - application/json

OK

The response is of type object.