`woo_list_customers`

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

List customers from a WooCommerce store.

Parameters

Name	Type	Required	Description
`_apiKey`	string	yes	WooCommerce consumer key
`_apiSecret`	string	yes	WooCommerce consumer secret
`_storeUrl`	string	yes	Store URL (e.g., https://mystore.com)
`per_page`	number	no	Results per page (max 100, default 20)
`page`	number	no	Page number (default 1)

Example call

Arguments

{
  "_apiKey": "your-woocommerce-api-key",
  "_apiSecret": "your-woocommerce-api-secret",
  "_storeUrl": "https://mystore.com"
}

curl

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

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('woo_list_customers', {
  "_apiKey": "your-woocommerce-api-key",
  "_apiSecret": "your-woocommerce-api-secret",
  "_storeUrl": "https://mystore.com"
});

Response shape

Always returns: items, count

Field	Type	Description
`items`	array	Array of customers from WooCommerce store
`count`	integer	Number of items returned.

Full JSON Schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "description": "Array of customers from WooCommerce store",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Customer ID"
          },
          "date_created": {
            "type": "string",
            "description": "Creation date in ISO format"
          },
          "date_modified": {
            "type": "string",
            "description": "Last modified date in ISO format"
          },
          "email": {
            "type": "string",
            "description": "Customer email address"
          },
          "first_name": {
            "type": "string",
            "description": "Customer first name"
          },
          "last_name": {
            "type": "string",
            "description": "Customer last name"
          },
          "role": {
            "type": "string",
            "description": "Customer role"
          },
          "username": {
            "type": "string",
            "description": "Customer username"
          },
          "billing": {
            "type": "object",
            "description": "Billing address details"
          },
          "shipping": {
            "type": "object",
            "description": "Shipping address details"
          },
          "is_paying_customer": {
            "type": "boolean",
            "description": "Whether customer is paying"
          }
        }
      }
    },
    "count": {
      "type": "integer",
      "description": "Number of items returned."
    }
  },
  "required": [
    "items",
    "count"
  ]
}

Connect

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

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

See Getting Started for client-specific install steps.

woo_list_customers