Skip to main content
GET
/
api
/
dashboard
/
customers
List Customers
curl --request GET \
  --url https://api.example.com/api/dashboard/customers
{
  "customers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "phone": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "full_name": "<string>",
      "default_address": {
        "first_name": "<string>",
        "last_name": "<string>",
        "company": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>",
        "phone": "<string>"
      },
      "addresses": [
        {
          "first_name": "<string>",
          "last_name": "<string>",
          "company": "<string>",
          "address1": "<string>",
          "address2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>",
          "phone": "<string>"
        }
      ],
      "accepts_marketing": true,
      "orders_count": 123,
      "total_spent": "<string>",
      "average_order_value": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "has_password": false,
      "email_verified_at": "2023-11-07T05:31:56Z",
      "marketing_opt_in": false,
      "failed_login_count": 0,
      "locked_until_at": "2023-11-07T05:31:56Z",
      "saved_addresses": []
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "pages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.stella-commerce.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

authorization
string | null
X-API-Key
string | null
X-Stella-Merchant-Id
string | null

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100
search
string | null

Response

Successful Response

Schema for paginated customer list.

customers
CustomerResponse · object[]
required
total
integer
required
page
integer
required
limit
integer
required
pages
integer
required