HelpWave Developer DocsHelpWave Dev DocsReference-first docs for v1 customers and tickets APIs
GET

/api/v1/customers/[customerId]

Fetch a single customer by numeric ID.

Authentication: API key required

Behavior
  • customerId is read from the route parameter and parsed with parseInt.
  • The lookup is scoped by both id and shopDomain.
  • If customerId is missing, the route returns 400 customerId is required.
  • If no matching customer exists inside the authenticated shop, the route returns 404 Customer not found.
  • The response includes a selected subset of customer fields rather than the full Prisma record.
Route parameters
  • customerId (required)

    Numeric customer identifier from the CRM database.

Response
Response example
{
  "success": true,
  "customer": {
    "id": 123,
    "shopify_id": "987654321",
    "wordpress_id": null,
    "prestashop_id": null,
    "fb_user_id": null,
    "ig_user_id": null,
    "whatsapp_id": null,
    "email": "dev@example.com",
    "phone_number": "+33123456789",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "full_name": "Ada Lovelace",
    "numberOfOrders": 0,
    "shopDomain": "example.myshopify.com",
    "creationDate": "2026-04-28T00:00:00.000Z",
    "cms_creationDate": null,
    "CMS": null,
    "zendesk_id": null,
    "freshdesk_id": null,
    "ig_pseudo": null,
    "gmelius_id": null,
    "gorgias_id": null
  }
}