Get Customer

GET /v2/tms-api/customers/{external_reference_id}

Retrieve details for a specific customer using its external reference ID.

API Reference

Path Parameters

external_reference_idstringrequired

The customer's external reference ID (from your system)

Request Examples

cURL

curl -X GET "https://api.mentium.io/v2/tms-api/customers/CUST-ACME-001" \
  -H "X-API-Key: your_api_key_here"

Python

import requests

response = requests.get(
    "https://api.mentium.io/v2/tms-api/customers/CUST-ACME-001",
    headers={"X-API-Key": "your_api_key_here"}
)
print(response.json())

Response

200 OK

{
  "id": "cust_abc123def456",
  "external_reference_id": "CUST-ACME-001",
  "name": "Acme Corporation",
  "reference_number": "ACME-REF-001",
  "domain": "acme.com",
  "phone": "312-555-0100",
  "is_active": true,
  "customer_type": "Enterprise",
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-29T14:20:00Z"
}

404 Not Found

{
  "detail": "Customer with external_reference_id 'CUST-ACME-001' not found"
}