Get listing of lists
|
1 |
GET /api/1/list |
Parameters
| Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
|---|---|---|---|---|---|
| Authorization: | Header | False | Required | String (Bearer {access token}) | Pass the authentication token that was granted when you authorized access. |
| listingtype | Query | false | Optional | String | Possible Values: CONTACT_LIST (Default value) HEADER FOOTER SENDER MEDIA PAGES CUSTOM_EVENTS TEMPLATE_MESSAGE DRAFT_MESSAGE LANDING_PAGE SENT_MESSAGE TRIGGERED_MESSAGE TEST_MESSAGE FAILED_MESSAGE SCHEDULED_MESSAGE |
| count | Query | false | Optional | String | Number of elements to download. (Default=1000, maximum=1000) |
| offset | Query | False | Optional | String | element at which the fetch begins. Default=0 |
The JSON response will include objects that have sourceId, baseId and id parameters.
sourceId is the real canonical ID for a given object in the API response.
- sourceId will begin with either “l-” “q-” or “g-“
- If the sourceId begins with “l-” it means it is a list and records can be added to it via the API
- If the sourceId begins with “q-” it is a logically defined segment of a list and records cannot be added to it via the API
- If the sourceId begins with “g-” it is an explicitly defined segment of a list and records cannot be added to it via the API
baseId and id are functionally equivalent. The baseId and id will reflect They will only differ from the sourceId if the sourceId starts with “q-” or “g-” and will represent the base list that the segment is built on.
Request
Following is an example HTTP request:
HTTP
|
1 2 3 4 |
GET /api/1/list?listingtype=CONTACT_LIST HTTP/1.1 Host: restapi.actonsoftware.com Authorization: Bearer 4f8c9c55844820a1881811aaf38beb Cache-Control: no-cache |
Following is an example curl request:
curl
|
1 |
curl -X GET -H "Authorization: Bearer 4f8c9c55844820a1881811aaf38beb" -H "Cache-Control: no-cache" https://restapi.actonsoftware.com/api/1/list?listingtype=CONTACT_LIST |
Response
A successful request results in an HTTP 200 response with a JSON object that contains the list listing.
An example JSON response from the above JSON request:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
{ "offset": 0, "count": 10, "totalCount": 10, "result": [ { "id": "l-0056", "name": "RobsAPI5Test", "folderName": "ROb", "sourceId": "l-0056", "baseId": "l-0056", "description": "Uploaded Marketing List", "sourceSize": "1", "sourceName": "RobsAPI5Test", "tsLastModified": 1392704558000, "tsLastCounted": 1392704559546, "tsSource": 1392704558000, "sourceTS": "Feb 17 2014 10:22 PM", "bIsSingleton": false, "bIsList": true, "bIsSforce": false, "bIsSforceReport": false, "bIsSforceAvailable": true, "bIsMSDyn": false, "bIsMSDynAvailable": true, "bIsSugar": false, "bIsSugarAvailable": true, "bIsSL": false, "bIsSLAvailable": true, "bIsNsuite": false, "bIsNsuiteAvailable": true }, { "id": "l-crm-cl-0", "name": "Sales Leads and Contacts", "folderName": "Default Folder", "sourceId": "l-crm-cl-0", "baseId": "l-crm-cl-0", "description": "CRM Leads / Contacts", "sourceSize": "0", "sourceName": "Sales Leads and Contacts", "tsLastModified": 1279207794000, "tsLastCounted": 0, "tsSource": 1279207794000, "sourceTS": "Jul 15 2010 8:29 AM", "bIsSingleton": true, "bIsList": true, "bIsSforce": false, "bIsSforceReport": false, "bIsSforceAvailable": true, "bIsMSDyn": false, "bIsMSDynAvailable": true, "bIsSugar": false, "bIsSugarAvailable": true, "bIsSL": false, "bIsSLAvailable": true, "bIsNsuite": false, "bIsNsuiteAvailable": true }, { "id": "l-005a", "name": "Gmail_contacts_of_genealogy@e-familytree.net", "folderName": "Default Folder", "sourceId": "l-005a", "baseId": "l-005a", "description": "Uploaded Marketing List", "sourceSize": "0", "sourceName": "Gmail_contacts_of_genealogy@e-familytree.net", "tsLastModified": 1394753565000, "tsLastCounted": 0, "tsSource": 1394753565000, "sourceTS": "Mar 13 2014 4:32 PM", "bIsSingleton": false, "bIsList": true, "bIsSforce": false, "bIsSforceReport": false, "bIsSforceAvailable": true, "bIsMSDyn": false, "bIsMSDynAvailable": true, "bIsSugar": false, "bIsSugarAvailable": true, "bIsSL": false, "bIsSLAvailable": true, "bIsNsuite": false, "bIsNsuiteAvailable": true }, { "id": "l-0059", "name": "test", "folderName": "Default Folder", "sourceId": "g-005b", "baseId": "l-0059", "description": "Explicitly Selected Group", "sourceSize": "1", "sourceName": "test", "tsLastModified": 1396395998159, "tsLastCounted": 1396395998857, "tsSource": 1396395998857, "sourceTS": "Apr 1 2014 4:46 PM", "bIsSingleton": false, "bIsList": false, "bIsSforce": false, "bIsSforceReport": false, "bIsSforceAvailable": true, "bIsMSDyn": false, "bIsMSDynAvailable": true, "bIsSugar": false, "bIsSugarAvailable": true, "bIsSL": false, "bIsSLAvailable": true, "bIsNsuite": false, "bIsNsuiteAvailable": true }, { "id": "l-0058", "name": "RobsAPI7Test", "folderName": "Default Folder", "sourceId": "l-0058", "baseId": "l-0058", "description": "Uploaded Marketing List", "sourceSize": "1", "sourceName": "RobsAPI7Test", "tsLastModified": 1392873649000, "tsLastCounted": 1392873650386, "tsSource": 1392873649000, "sourceTS": "Feb 19 2014 9:20 PM", "bIsSingleton": false, "bIsList": true, "bIsSforce": false, "bIsSforceReport": false, "bIsSforceAvailable": true, "bIsMSDyn": false, "bIsMSDynAvailable": true, "bIsSugar": false, "bIsSugarAvailable": true, "bIsSL": false, "bIsSLAvailable": true, "bIsNsuite": false, "bIsNsuiteAvailable": true }, { "id": "l-0057", "name": "RobsAPI6Test", "folderName": "Default Folder", "sourceId": "l-0057", "baseId": "l-0057", "description": "Uploaded Marketing List", "sourceSize": "1", "sourceName": "RobsAPI6Test", "tsLastModified": 1392870891000, "tsLastCounted": 1392870892767, "tsSource": 1392870891000, "sourceTS": "Feb 19 2014 8:34 PM", "bIsSingleton": false, "bIsList": true, "bIsSforce": false, "bIsSforceReport": false, "bIsSforceAvailable": true, "bIsMSDyn": false, "bIsMSDynAvailable": true, "bIsSugar": false, "bIsSugarAvailable": true, "bIsSL": false, "bIsSLAvailable": true, "bIsNsuite": false, "bIsNsuiteAvailable": true }, { "id": "l-0055", "name": "RobsAPI4Test", "folderName": "Default Folder", "sourceId": "l-0055", "baseId": "l-0055", "description": "Uploaded Marketing List", "sourceSize": "0", "sourceName": "RobsAPI4Test", "tsLastModified": 1392703511000, "tsLastCounted": 0, "tsSource": 1392703511000, "sourceTS": "Feb 17 2014 10:05 PM", "bIsSingleton": false, "bIsList": true, "bIsSforce": false, "bIsSforceReport": false, "bIsSforceAvailable": true, "bIsMSDyn": false, "bIsMSDynAvailable": true, "bIsSugar": false, "bIsSugarAvailable": true, "bIsSL": false, "bIsSLAvailable": true, "bIsNsuite": false, "bIsNsuiteAvailable": true } ] } |
If the “sourceID” and “baseID” are different then the list is a Segment.
For Segments the “sourceID” is the SegmentID, “sourceName” is the segment name, and “description” indicates the source of the segment. Possible values for “description” include “Explicitly Selected Group” (corresponds to “Direct Selection” in the UI), “Saved Search Result” (corresponds to “Search” in the UI), and “Segment” (corresponds to “Query” in the UI).
Code Examples
These examples use the java unirest library available at unirest.io. You can also find unirest libraries for node, ruby, php, java, objective c, python, and .net.
Java
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
package com.acton.api.client.endpoint; import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.JsonNode; import com.mashape.unirest.http.Unirest; import com.mashape.unirest.http.exceptions.UnirestException; public class ListExample { static String BASE_URL = "https://restapi.actonsoftware.com/"; static String ACTON_USERNAME = ""; static String ACTON_PASSWORD = ""; static String CLIENT_ID = ""; static String CLIENT_SECRET = ""; public static void main(String[] args) { try { String access_token = getAccessToken(); Unirest.setDefaultHeader("Authorization", "Bearer " + access_token); printListCount(); } catch (UnirestException e) { e.printStackTrace(); } } /* * This method used GET list listing api, and prints the total number of lists. */ private static void printListCount() throws UnirestException { HttpResponse listResponse = Unirest.get(BASE_URL + "/api/1/list").asJson(); System.out.println("Total number of lists : " + listResponse.getBody().getObject().getInt("totalCount")); } /* * This is a utilty method to get access token */ private static String getAccessToken() throws UnirestException { //POST to token url with password grant_type to get token. HttpResponse jsonResponse = Unirest.post(BASE_URL + "token") .header("accept", "application/json") .field("grant_type", "password") .field("username", ACTON_USERNAME) .field("password", ACTON_PASSWORD) .field("client_id", CLIENT_ID) .field("client_secret", CLIENT_SECRET) .asJson(); //Strip access_token from response and return it. return jsonResponse.getBody().getObject().getString("access_token"); } } |
