`qb_get_customer`

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

Retrieve a customer’s complete profile including contact info, email, phone, and account balance by customer ID.

Parameters

Name	Type	Required	Description
`id`	string	yes	QuickBooks Customer ID

Example call

Arguments

{
  "id": "1"
}

curl

curl -X POST https://gateway.pipeworx.io/quickbooks/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"qb_get_customer","arguments":{"id":"1"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('qb_get_customer', {
  "id": "1"
});

More examples

{
  "id": "42"
}

Response shape

Full JSON Schema

{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "error": {
          "type": "string",
          "description": "Error code if connection not configured"
        },
        "message": {
          "type": "string",
          "description": "Error message with setup instructions"
        }
      },
      "required": [
        "error",
        "message"
      ]
    },
    {
      "type": "object",
      "properties": {
        "Customer": {
          "type": "object",
          "description": "Customer profile with contact info, email, phone, and balance",
          "properties": {
            "Id": {
              "type": "string",
              "description": "Customer ID"
            },
            "DisplayName": {
              "type": "string",
              "description": "Customer display name"
            },
            "PrimaryEmailAddr": {
              "type": "object",
              "properties": {
                "Address": {
                  "type": "string",
                  "description": "Email address"
                }
              }
            },
            "PrimaryPhone": {
              "type": "object",
              "properties": {
                "FreeFormNumber": {
                  "type": "string",
                  "description": "Phone number"
                }
              }
            }
          }
        }
      }
    }
  ]
}

Connect

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

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

See Getting Started for client-specific install steps.

qb_get_customer