TMS API
TMS API - Customers

List Customers

List all customers with optional filtering and pagination.

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)
  • Auth
    none declared

Query parameters

name_containsstring nullable

Filter by name

is_activeboolean nullable

Filter by active status

customer_typestring nullable

Filter by customer type

limitinteger

Number of items

offsetinteger

Offset for pagination

sort_bystring nullable

Sort field

sort_order'asc' | 'desc'

Sort order options.

Sort order

Headers

X-API-Keystring nullable

API key for authentication

Response

Successful Response

total_countinteger required

Total number of items matching the query

has_moreboolean required

Whether there are more items available

limitinteger required

Number of items requested

offsetinteger required

Number of items skipped

Changes

No recorded changes to this operation across all 2 revisions of this API.