List_Get_Active_Lists

List_Get_Active_Lists( string keyoptional structoptionalParameters)

Note: When using one of the API wrappers, you do not need to pass the API key. The wrapper will pass the key for you, your first parameter should be the second parameter in the signature.

Description

Get a listing of currently active lists.

Parameters

  string key Your API key - used to authenticate your account
optional struct optionalParameters A struct of optional parameters, see below for valid keys

optionalParameters can include:

string type Return only lists of a given type, value values: public, private, test, internal
string sortBy Field to sort by, value values: name, description, id, type, status
string sortDir Sort direction, valid values: U, D
int offset The number of records to skip (specify a starting point)
int num The maximum number of records to return

Return

struct Array of records with the key of listId and values of listId, name, description, type and listOwnerEmail
 

Still need help? Contact Us Contact Us