Last updated: 12/3/2024 11:52:45 PM
![]() |
NoteBusiness role: Distributor (T1), ISP (T1), MSP (T2), and Reseller (T2)
|
This API is used to retrieve the user profile and customer company ID under a specific
partner (the API caller).
Request
HTTP Request
[GET] /LMPI/v3/customers
Parameters
Name
|
Type
|
Description
|
Validation
|
||
Required Parameters
|
|||||
created_start
|
date
|
The start date of the period you want to query.
|
ISO 8601 standard with format "YYYY-MM-DDThh:mm:ssZ"
|
||
created_end
|
date
|
The end date of the period you want to query.
|
ISO 8601 standard with format "YYYY-MM-DDThh:mm:ssZ"
|
||
Optional Parameters
|
|||||
page
|
integer
|
The page number you want to query.
|
Positive integer, default value: 1
|
||
limit
|
integer
|
The number of records per page.
|
Positive integer (1-100), default: is 25
|
HTTP Request Example
[GET] https://{lmpi-fqdn}/LMPI/v3/customers?created_start=2021-12-03T10:13:00Z&created_end=2021-12-31T00:00:00Z
Do not supply a request body with this method.
Response
Response
If successful, this method returns an HTTP 200 OK status code and a response body
with the following structure:
{ "paging": { "total": 2, "limit": 25, "page": 1 }, "customers": [{ "customer_id": "XXXdbd77-e116-45a0-8f97-c486021dcXXX" "name" : "Stay Green Greenery", "address" : "160711 Ventura Blvd", "city" : "Encino", "state" : "CA", "postal_code" : "101", "country" : "US", "status": 1, "note" : "", "emergency_email" : "support@trendmicro.com" }, { "customer_id": "XXX4a7fc-4fb0-4e07-88a4-973779a6dXXX" "name" : "Vera Company", "address" : "160711 XXX Adress", "city" : "XXCity", "state" : "CA", "postal_code" : "101", "country" : "US", "status": 1, "note" : "", "emergency_email" : "tm@trendmicro.com;support@trendmicro.com" } ] }
Name
|
Type
|
Description
|
Length
|
paging.total
|
integer
|
The total number of records.
|
Positive integer
|
paging.limit
|
integer
|
The number of records per page.
|
Positive integer
|
paging.page
|
integer
|
The current page number (1-maximum).
|
Positive integer
|
customers[].customer_id
|
string
|
The unique identifier of the current customer company.
|
GUID format
|
customers[].name
|
string
|
The name of the customer company.
|
1-128 characters
|
customers[].address
|
string
|
The address of the customer company.
|
0-128 characters
|
customers[].city
|
string
|
The city where the customer company is located.
|
0-64 characters
|
customers[].state
|
string
|
The state where the customer company is located.
|
1-64 characters
|
customers[].postal_code
|
string
|
The postal code of the customer company.
|
0-10 characters
|
customers[].country
|
string
|
The country code where customer company is located.
|
ISO 3166-1 alpha-2 country code
|
customers[].status
|
integer
|
The status of the current customer company.
Possible values include:
|
Valid status
|
customers[].note
|
string
|
Additional notes on the current customer company.
|
0-500 characters
|
customers[].emergency_email
|
string
|
The emergency contact information, using semicolons to separate multiple email addresses.
Trend Micro uses the emergency contact email if any critical issue of service occurs.
|
0-500 characters with email format (limited to letters, numbers, hyphens, periods,
underscores, and "@")
|