Last updated: 1/22/2020 12:10:04 AM
![]() |
NoteBusiness role: Distributor (T1), ISP (T1), MSP (T2), and Reseller (T2)
|
This API is used to retrieve user profile and customer company ID which are under
specific partner (API caller).
![]() |
TipOnly the modified user profile is provided. If you cannot get what you need from the
API response, it means that the user profile does not exist or has never been updated.
|
Request
HTTP Request
[GET] /LMPI/v2/customers
Parameters
Name
|
Type
|
Description
|
Validation
|
Required Parameters
|
|||
user_modified_start
|
date
|
The start date of period you want to query. If the modified date of user's profile
is larger than user_modified_start, and less than user_modified_end, that record will
be returned.
|
ISO 8601 standard with format "YYYY-MM-DDThh:mm:ssZ"
|
user_modified_end
|
date
|
The end date of period you want to query. If the modified date of user's profile is
larger than user_modified_start, and less than user_modified_end, that record will
be returned.
|
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 record per page.
|
Positive integer (1-100), default value: 25
|
HTTP Request Example
[GET] https://{lmpi-fqdn}/LMPI/v2/customers?user_modified_start=2013-01-01T00:00:00Z&us er_modified_end=2014-04-30T00:00:00Z
Do not supply a request body with this method.
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 }, "users": [{ "status": 1, "first_name": "0917c01", "last_name": "0917c01", "user_id": "49df9594-e4e6-42a3-8c4c-218cab3260e5", "note":null, "language": "en-US", "time_zone": "GMT Standard Time", "email": "vera_wang@trend.com.tw", "phone": { "area_code": null, "number": null, "extension": null }, "customer_id": "87a72ccc-342a-4cda-9484-2f9480be71a6", "login_name": "0917c01", "emergency_email": "tm@trendmicro.com;support@trendmicro.com" }, { "status": 1, "first_name": "1220c01", "last_name": "1220c01", "user_id": "f628fb4b-0207-4dba-9b31-84b75476351f", "note":null, "language": "en-US", "time_zone": "Taipei Standard Time", "email": "1220c01@yopmail.com", "phone": { "area_code": null, "number": null, "extension": null }, "customer_id": "3e91b157-0bd6-4cc3-9d8c-611d4c5d0166", "login_name": "1220c01" }] }
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.
|
Positive integer
|
users[].user_id
|
string
|
The unique identifier of current user account.
|
GUID format
|
users[].customer_id
|
string
|
The unique identifier of current customer company.
|
GUID format
|
users[].note
|
string
|
Additional note of current customer company.
|
0-500 characters
|
users[].status
|
integer
|
The status of current user account. 0: disable. 1: enable.
|
1 digit
|
users[].login_name
|
string
|
The login name of user account, used to sign in to Customer Licensing Portal.
|
4-25 characters
|
users[].first_name
|
string
|
The current user's first name.
|
1-50 characters
|
users[].last_name
|
string
|
The current user's last name.
|
1-50 characters
|
users[].email
|
string
|
The current user's contact email.
|
1-128 characters
|
users[].time_zone
|
string
|
The preferred time zone.
|
Valid time zone (e.g. Pacific Standard Time)
|
users[].language
|
string
|
The preferred language code, used to determine the language preference of Customer
Licensing Portal.
|
Valid language code (e.g. en-US)
|
users[].phone.area_code
|
string
|
The area code of user's contact phone number.
|
Positive integer, 0-5 digits
|
users[].phone.number
|
string
|
The contact phone number of the user.
|
0-16 characters (limited to numbers, plus signs, minus signs, periods, and brackets)
|
users[].phone.extension
|
string
|
The extension of user's contact phone number.
|
Positive integer (0-10)
|
users[].emergency_email
|
string
|
The emergency contact information.
|
0-500 characters
|