Skip to main content
POST
/
api
/
ext-v1
/
customer
/
queryCustomer
curl -X POST https://admin.telemetron.ai/api/ext-v1/customer/queryCustomer \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john.doe@example.com"
  }'
{
  "id": "cust_a1b2c3d4e5f6",
  "organizationId": "org_123456",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "address": "123 Main St, City, State 12345",
  "devices": ["device_001", "device_002"],
  "orders": ["order_001", "order_002"],
  "metadata": {},
  "createdAt": "2025-10-01T12:00:00Z"
}

Overview

Retrieves customer information by email address. Response includes assigned devices.

Authentication

x-api-key
string
required
Your organization’s API key

Request Body

email
string
required
The email address of the customer to query

Response

id
string
The unique customer identifier (telemetronCustomerId)
organizationId
string
The organization ID this customer belongs to
name
string
Customer’s full name
email
string
Customer’s email address
phone
string
Customer’s phone number (if provided)
address
string
Customer’s address (if provided)
devices
array
Array of device identifiers assigned to this customer
orders
array
Array of order identifiers associated with this customer
metadata
object
Additional customer metadata
createdAt
string
ISO 8601 timestamp of when the customer was created

Examples

Request

curl -X POST https://admin.telemetron.ai/api/ext-v1/customer/queryCustomer \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john.doe@example.com"
  }'

Response

{
  "id": "cust_a1b2c3d4e5f6",
  "organizationId": "org_123456",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "address": "123 Main St, City, State 12345",
  "devices": ["device_001", "device_002"],
  "orders": ["order_001", "order_002"],
  "metadata": {},
  "createdAt": "2025-10-01T12:00:00Z"
}
curl -X POST https://admin.telemetron.ai/api/ext-v1/customer/queryCustomer \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john.doe@example.com"
  }'
{
  "id": "cust_a1b2c3d4e5f6",
  "organizationId": "org_123456",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "address": "123 Main St, City, State 12345",
  "devices": ["device_001", "device_002"],
  "orders": ["order_001", "order_002"],
  "metadata": {},
  "createdAt": "2025-10-01T12:00:00Z"
}

Status Codes

CodeDescription
200Customer found and returned successfully
400Invalid request (missing email or invalid JSON)
401Invalid or missing API key
404Customer not found with the provided email
500Internal server error

Notes

  • Email lookup is case-insensitive
  • Returns only customers in your organization
  • devices array contains assigned device identifiers