listPartners
Description
This action will retrieve all the partners by the specified filters
Example
https://api.jetlicense.com/?action=listPartners&status[]=Active&status[]=Suspended&limit=20&skip=10
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
output |
String | The requested returned output type, The default is json |
|
xml |
status |
Array | The partners statuses that you want to retrieve |
|
[Active, Suspended] |
limit |
Integer | The maximum number of partners to retrieve |
|
20 |
skip |
Integer | The number of partners to skip from the start |
|
10 |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
total |
Integer | The total Partners retrieved |
|
10 |
partners |
Object | The Partners list |
|
Object(
) |
— partner_id |
String | The Partner ID |
|
5888bf6319a464498902b0ce |
— partner_name |
String | The Partner Name |
|
JetApps |
— status |
String | The Partner status |
|
Active |
— status_change |
String | The Partner status last change date |
|
2017-01-26T16:51:13+00:00 |
— created |
String | The Partner creation date |
|
2017-01-26T16:51:13+00:00 |