---
title: "List Customers"
method: GET
path: "/v2/tms-api/customers"
tags: ["TMS API", "TMS API - Customers"]
---

# List Customers

`GET /v2/tms-api/customers`

## Request

- Base URL: `https://api.mentium.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mentium.io/v2/tms-api/customers`
- Auth: none declared

List all customers with optional filtering and pagination.

## Query parameters

- `name_contains` string, nullable: Filter by name
- `is_active` boolean, nullable: Filter by active status
- `customer_type` string, nullable: Filter by customer type
- `limit` integer: Number of items
- `offset` integer: Offset for pagination
- `sort_by` string, nullable: Sort field
- `sort_order` 'asc' | 'desc': Sort order options.

## Headers

- `X-API-Key` string, nullable: API key for authentication

## Response `200`

Successful Response

- PaginatedResponseCustomerResponse
  - `data` CustomerResponse[], required: List of items
    - `id` string, required: Internal Mentium ID
    - `external_reference_id` string, required: External reference ID from your system
    - `name` string, required: Customer name
    - `reference_number` string, nullable: Additional reference
    - `domain` string, nullable: Customer domain/website
    - `phone` string, nullable: Phone number
    - `is_active` boolean, required: Is the customer active
    - `customer_type` string, nullable: Customer type/category
    - `created_at` string, date-time, required: Creation timestamp
    - `updated_at` string, date-time, required: Last update timestamp
  - `total_count` integer, required: Total number of items matching the query
  - `has_more` boolean, required: Whether there are more items available
  - `limit` integer, required: Number of items requested
  - `offset` integer, required: Number of items skipped

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/mentium/apis/mentium-api.md) - [All operations](https://skmtc.dev/mentium/apis/mentium-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mentium/apis/mentium-api/revisions/b4ed8e59432e?raw)