List Customers

GET /v2/tms-api/customers

Retrieve a paginated list of customers in your organization.

API Reference

Query Parameters

pageintegerdefault: 1

Page number (1-indexed)

page_sizeintegerdefault: 50

Number of items per page (max 100)

name_containsstring

Filter by name (contains search)

is_activeboolean

Filter by active status

customer_typestring

Filter by customer type

sortstring

Sort field and direction. Format: `field` (ascending) or `-field` (descending). Valid fields: `name`, `created_at`, `updated_at`

Request Examples

cURL

# List all customers
curl -X GET "https://api.mentium.io/v2/tms-api/customers?page=1&page_size=50" \
  -H "X-API-Key: your_api_key_here"

# Filter by active status
curl -X GET "https://api.mentium.io/v2/tms-api/customers?is_active=true" \
  -H "X-API-Key: your_api_key_here"

# Search by name
curl -X GET "https://api.mentium.io/v2/tms-api/customers?name_contains=Acme" \
  -H "X-API-Key: your_api_key_here"

Python

import requests

response = requests.get(
    "https://api.mentium.io/v2/tms-api/customers",
    headers={"X-API-Key": "your_api_key_here"},
    params={"page": 1, "page_size": 50, "is_active": True}
)
print(response.json())

Response

200 OK

{
  "items": [
    {
      "id": "cust_abc123",
      "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"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 50,
    "total": 1,
    "total_pages": 1,
    "has_more": false
  }
}