» Lists » Lists » Get

GET lists

Retrives the user's lists

Resource

Method GET
URL http://api.responder.co.il/v1.0/lists

Parameters

list_ids
optional

A comma separated list of List IDs to be retrived.
Invalid ID's will be returned in a JSON array of "INVALID_LIST_IDS"
NOTE! when used with "limit" or "offset" results are unpredictable

Example value: 123456,456
limit
optional

Maximum number of Lists to be retrived.
Range between 1 to 500.

Example value: 25
Default value: 500
offset
optional

The position to start the count of "limit" from.
Value must be larger or equal to 0

Example value: 10
Default value: 0

Example

GET http://api.responder.co.il/v1.0/lists

Response

{
   "LISTS" : [
      {
         "ID" : 123456,
         "DESCRIPTION" : "The List",
         "REMOVE_TITLE" : "Bye Bye!",
         "SITE_NAME" : "Responder!",
         "SITE_URL" : "http://www.esponder.co.il",
         "LOGO" : "http://www.responder.co.il/images/wn_06.gif",
         "SENDER_NAME" : "Someone",
         "SENDER_EMAIL" : "someone@responder.co.il",
         "SENDER_ADDRESS" : "Somewhere At Responder",
         "NAME" : "english_name",
         "AUTH_MAIL_SUBJECT" : "",
         "AUTH_MAIL_BODY" : "",
         "AUTH_MAIL_LINK" : "",
         "AUTH_MAIL_DIR" : "",
         "AUTH_MAIL_PAGE" : "",
         "AUTH_MAIL_FORM" : "",
         "AUTH_MAIL_MANUAL" : "",
         "EMAIL_NOTIFY" : {
            "first@responder.co.il",
            "second@responder.co.il"
         },
         "AUTOMATION" : {
            123457 : "First List",
            123458 : "Another List"
         }
      }
   ],
   "INVALID_LIST_IDS" : [456]
}