listPartners

Description

This function returns a list of partners by the specified filters

Parameters

Parameter name Type Description Possible values Example
output String The requested returned output type, The default is json
  • json - Default
  • xml
  • text
  • debug
 xml
status Array The partners statuses that you want to retrieve
  • Active
  • Suspended
  • Cancelled
 [Active, Suspended]
limit Integer The maximum number of partners to retrieve
  • 0 up to 999
 20
skip Integer The number of partners to skip from the start
  • 0 up to ~
 10

Returns

Return Type Description Possible values Example
total Integer The total Partners retrieved
  • 0 up to ~
 10
partners Object The Partners list
  • Partners Object
Object (
  • partner_id
  • partner_name
  • status
  • status_change
  • created )
partner_id String The Partner ID
  • Partner ID
 5888bf6319a464498902b0ce
partner_name String The Partner Name
  • Partner Name
 JetApps
status String The Partner status
  • Active
  • Suspended
  • Cancelled
 Active
status_change String The Partner status last change date Date 2017-01-26T16:51:13+00:00
created String The Partner creation date Date 2017-01-26T16:51:13+00:00

Example

https://api.jetlicense.com/?action=listPartners&status[]=Active&status[]=Suspended&limit=20&skip=10