Metorik Docs

Customers

Customer data

Returns customers from your store together with all-time customer
statistics, or period-based customer statistics when order_start_date
and order_end_date are provided. All returned *_at timestamps are in
UTC.

GET /api/v1/store/customers

Customer data

curl --request GET \
  --url 'https://{baseUrl}/api/v1/store/customers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "data": [
    {
      "customer_id": 482,
      "full_name": "Tony Stark",
      "first_name": "Tony",
      "last_name": "Stark",
      "email": "[email protected]",
      "customer_created_at": "2026-03-01T08:00:00Z",
      "customer_updated_at": "2026-03-25T18:42:00Z",
      "billing_address_first_name": "Tony",
      "billing_address_last_name": "Stark",
      "billing_address_company": "Stark Industries",
      "billing_address_address_1": "10880 Malibu Point",
      "billing_address_address_2": "Suite 1",
      "billing_address_city": "Malibu",
      "billing_address_state": "CA",
      "billing_address_postcode": "90265",
      "billing_address_country": "US",
      "billing_address_phone": "5551234567",
      "shipping_address_first_name": "Tony",
      "shipping_address_last_name": "Stark",
      "shipping_address_company": "Stark Industries",
      "shipping_address_address_1": "10880 Malibu Point",
      "shipping_address_address_2": "Suite 1",
      "shipping_address_city": "Malibu",
      "shipping_address_state": "CA",
      "shipping_address_postcode": "90265",
      "shipping_address_country": "US",
      "shipping_address_phone": "5551234567",
      "role": "customer",
      "first_order_date": "2026-03-10T14:15:00Z",
      "last_order_date": "2026-03-25T18:42:00Z",
      "order_count": 3,
      "item_count": 7,
      "total_spent": 210.5,
      "average_order": 70.17,
      "subscription_count": 1,
      "metorik_profile": false,
      "resource_link": "https://app.metorik.com/customers/482"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "has_more_pages": true
  }
}

No response description.

Authorizations

  • Authorization string required header

    Generate a store API key from the store's Metorik API settings in Metorik, and choose the scopes needed for the endpoints you want to call.

Query Parameters

  • filters string

    Optional JSON-encoded filter array. See Customer Filters Reference. Example: [{"field":"total_spent","operator":"gte","value":100},{"field":"role","operator":"eq","value":"customer"}]

  • order_by string enum

    Sort field. Example: customer_created_at

  • order_dir string enum

    Sort direction. Example: desc

  • order_end_date string

    Optional end date in the store timezone using YYYY-MM-DD format. Requires order_start_date. When provided, customer order stats are calculated for this period. Example: 2026-03-31

  • order_start_date string

    Optional start date in the store timezone using YYYY-MM-DD format. Requires order_end_date. When provided, customer order stats are calculated for this period. Example: 2026-03-01

  • page integer

    Page number for pagination. Example: 1

  • per_page integer

    Number of customers per page. Min 1, max 100. Example: 10

  • search string

    Search term to filter customers. Example: jarvis

Headers

  • Accept string required

    Response format header. Example: application/json

Response

application/json
  • data[] object array
    + Show Child Attributes
    • customer_id integer
    • full_name string
    • first_name string
    • last_name string
    • email string
    • customer_created_at string
    • customer_updated_at string
    • billing_address_first_name string
    • billing_address_last_name string
    • billing_address_company string
    • billing_address_address_1 string
    • billing_address_address_2 string
    • billing_address_city string
    • billing_address_state string
    • billing_address_postcode string
    • billing_address_country string
    • billing_address_phone string
    • shipping_address_first_name string
    • shipping_address_last_name string
    • shipping_address_company string
    • shipping_address_address_1 string
    • shipping_address_address_2 string
    • shipping_address_city string
    • shipping_address_state string
    • shipping_address_postcode string
    • shipping_address_country string
    • shipping_address_phone string
    • role string
    • first_order_date string
    • last_order_date string
    • order_count integer
    • item_count integer
    • total_spent number
    • average_order number
    • subscription_count integer
    • metorik_profile boolean
    • resource_link string
  • pagination object
    + Show Child Attributes
    • current_page integer
    • per_page integer
    • has_more_pages boolean