Last Updated: 1/22/2020 12:11:01 AM
List customers
Request
HTTP Request
GET /SMPI/{version}/service/wfbss/api/customers
Parameters
Name |
Type |
Description |
Validation |
---|---|---|---|
Optional Parameters |
|||
q |
string |
Keywords to be searched on company name |
|
page |
integer |
Page number |
1 to max. If not set, default is 1 |
limit |
integer |
Number of records per page |
1 to 100. If not set, default is 100 |
HTTP Request Example
List the first page of all your customers (100 records per page): GET /SMPI/{version}/service/wfbss/api/customers List the 2nd page of all your customers (50 records per page): GET /SMPI/{version}/service/wfbss/api/customers?page=2&limit=50 List the first page of your customers filtered with given company name (100 records per page): GET /SMPI/{version}/service/wfbss/api/customers?q=trend
Request Body
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": 1, "limit": 100, "page": 1 }, "customers": [ { "license_period": 1, "auto_renewal": 0, "name": "jesse t2 e4 cmp name", "time_zone": "Asia/Taipei", "seat_count": 30, "expire": "2013-06-01T15:59:59Z", "sp_subscription": "monthly USA", "license_type": "1", "id": "AD38F82D-51A1-46FD-B167-E0D0FF31BE83", "eid": "05ACB83A-E709-47B5-98C1-6CEA25476536" } ] }
Name |
Type |
Description |
Length |
---|---|---|---|
paging.total |
integer |
The total number of records |
|
paging.limit |
integer |
The number of records per page |
1 to 100 |
paging.page |
integer |
page number |
1 to max |
customers[].license_period |
integer |
The period of the license in month |
|
customers[].auto_renewal |
integer |
Auto renewal |
0 = false, 1 = true |
customers[].license_type |
integer |
License version type |
0 = trial, 1 = full |
customers[].name |
string |
Company name |
|
customers[].time_zone |
string |
The preference(or default) Time Zone of this user |
valid standard TimeZone code. |
customers[].expire |
string |
Expiration date |
ISO8601 date and time formats: YYYY-MM-DDThh:mmZ |
customers[].sp_subscription |
string |
Service plan name |
|
customers[].seat_count |
integer |
Seat count |
|
customers[].id |
string |
Customer ID |
GUID |
customers[].eid |
string |
Internal use only |
GUID |