Skip to main content
GET
/
api
/
v1
/
customers.json
List Customers
curl --request GET \
  --url https://api.launchmystore.io/api/v1/customers.json \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data.items": [
    {
      "id": "<string>",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "verified_email": true,
      "accepts_marketing": true,
      "orders_count": 123,
      "total_spent": 123,
      "tags": [
        {}
      ],
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "data.pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "hasMore": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.launchmystore.io/llms.txt

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

​
List Customers

Returns a paginated list of customers for the store.

​
Request

curl -X GET "https://api.launchmystore.io/api/v1/customers" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Parameters

​
page
integer
default:"1"
Page number for pagination
​
limit
integer
default:"50"
Number of items per page (max 250)
​
email
string
Filter by exact email address
​
query
string
Search customers by name, email, or phone
​
created_at_min
string
Filter customers created after this date (ISO 8601)
​
created_at_max
string
Filter customers created before this date (ISO 8601)
​
updated_at_min
string
Filter customers updated after this date (ISO 8601)
​
accepts_marketing
boolean
Filter by marketing opt-in status
​
tags
string
Filter by tags (comma-separated)

​
Response

​
success
boolean
Whether the request succeeded
​
data.items
array
Array of customer objects
​
data.pagination
object
Pagination information

​
Example Response

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "cust_abc123",
        "email": "john.doe@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "phone": "+1-555-123-4567",
        "verified_email": true,
        "accepts_marketing": true,
        "orders_count": 5,
        "total_spent": 25000,
        "tags": ["VIP", "wholesale"],
        "default_address": {
          "id": "addr_123",
          "address1": "123 Main St",
          "city": "New York",
          "province": "NY",
          "country": "US",
          "zip": "10001"
        },
        "created_at": "2023-06-15T10:30:00Z",
        "updated_at": "2024-01-20T14:45:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 1250,
      "hasMore": true
    }
  }
}

​
Error Codes

CodeDescription
UNAUTHORIZEDInvalid or missing access token
FORBIDDENApp doesn’t have read_customers scope