shopify_list_customers

Pack: shopify · Endpoint: https://gateway.pipeworx.io/shopify/mcp

List customers from a Shopify store.

Parameters

NameTypeRequiredDescription
_apiKeystringyesShopify Admin API access token
_shopstringyesShop domain (e.g., mystore.myshopify.com)
limitnumbernoNumber of customers to return (max 250, default 50)

Example call

Arguments

{
  "_apiKey": "your-shopify-api-key",
  "_shop": "mystore.myshopify.com"
}

curl

curl -X POST https://gateway.pipeworx.io/shopify/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"shopify_list_customers","arguments":{"_apiKey":"your-shopify-api-key","_shop":"mystore.myshopify.com"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('shopify_list_customers', {
  "_apiKey": "your-shopify-api-key",
  "_shop": "mystore.myshopify.com"
});

More examples

{
  "_apiKey": "your-shopify-api-key",
  "_shop": "mystore.myshopify.com",
  "limit": 150
}

Response shape

FieldTypeDescription
customersarrayList of customers
Full JSON Schema
{
  "type": "object",
  "properties": {
    "customers": {
      "type": "array",
      "description": "List of customers",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Customer ID"
          },
          "email": {
            "type": "string",
            "description": "Customer email"
          },
          "first_name": {
            "type": "string",
            "description": "Customer first name"
          },
          "last_name": {
            "type": "string",
            "description": "Customer last name"
          },
          "created_at": {
            "type": "string",
            "description": "Creation timestamp"
          },
          "updated_at": {
            "type": "string",
            "description": "Last update timestamp"
          },
          "orders_count": {
            "type": "number",
            "description": "Total orders placed"
          },
          "total_spent": {
            "type": "string",
            "description": "Total amount spent"
          },
          "state": {
            "type": "string",
            "description": "Customer state"
          }
        }
      }
    }
  }
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "shopify": {
      "url": "https://gateway.pipeworx.io/shopify/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build May 9, 2026