Download a list
|
1 |
GET/api/1/list/{listid} |
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. |
| listid | Path | False | Required | String | The id of list to be updated {listid} in path above). |
| count | Query | false | optional | String (default="1000", maximum="1000") | Number of records to download. |
| offset | Query | false | Optional | String (default="0") | Index into the list; where to start downloading. |
| modbefore | Query | False | Optional | String | Filter on date "modified before timestamp." * |
| modafter | Query | False | Optional | String | Filter on date "modified after timestamp." * |
| createdbefore | Query | False | Optional | String | Filter on date "created before timestamp." * |
| createdafter | Query | False | Optional | String | Filter on date "created after timestamp." * |
| fields | Query | False | Optional | String (semicolon delimited list) | A semicolon ( ; ) delimited list of fields to display in the returned list. Fields provided should be urlencoded. The "_contact_id_" field is always returned. This parameter is optional. If it is not provided, the whole list will be returned. The query parameter "datequalifiers" cannot be used in conjunction with this option. However, date modified and created timestamp* data can be added while using this option by specifying the field names "__modified_date" and/or "__created_date" in the list of fields to display. |
| datequalifiers | Query | False | Optional | Boolean true/false |
If specified as "true", the returned list will include timestamps* for each row denoting the dates created and modified. These columns will be headed with the names "__created_date" and "__modified_date". This option cannot be specified in conjunction with the query parameter "fields", and can only be appended to a complete (all fields present) list return. |
| responseformat | Query | False | Optional | String | Desired response format. Valid values are JSON and CSV with JSON being the default value. If CSV is specified then the first row will be the headers and following rows will be double quoted comma separated values. While JSON is limited to 1,000 list members per API call, CSV can return the entire list even if it is large. For JSON response format the number of fields is limited to 255. For CSV response format the number of fields is unlimited. |
* Note: Unix timestamp, in milliseconds. (timestamp converter:example)
Request
The following request examples use the ID for an example list that is available in every developer account:
HTTP
|
1 2 3 4 |
GET /api/1/list/l-ctx HTTP/1.1 Host: restapi.actonsoftware.com Authorization: Bearer 8a9911f75edbcaa33167831f5346b88 Cache-Control: no-cache |
curl
|
1 |
curl -X GET -H "Authorization: Bearer 8a9911f75edbcaa33167831f5346b88" -H "Cache-Control: no-cache" https://restapi.actonsoftware.com/api/1/list/l-ctx |
Response
A successful request results in an HTTP 200 response with a JSON object like the following. Note that the JSON lists the ID, any offset, the number of rows, and the headers before listing the data:
|
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 |
{ "listId":"l-ctx", "offset":0, "count":3, "headers":[ "_contact_id_", "E-mail Address", "First Name", "Last Name", "Company", "Middle Name", "Job Title", "Department", "Business Street", "Business City", "Business State", "Business Postal Code", "Business Country", "Home Street", "Home City", "Home State", "Home Postal Code", "Home Country", "Business Phone", "Business Fax", "Home Phone", "Home Fax", "Cell Phone", "Business Web Page", "Personal Web Page" ], "data":[ [ "l-ctx:a36", "remove209.162.194.106@db.justspam.org", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], [ "l-ctx:a38", "remove@db.justspam.org", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], [ "l-ctx:a3a", "Rob+Second@salzman.us", "Rob", "Salzman", "Second Contact", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] ] } |
A request made defining the “fields” parameter as fields=E-mail%20Address;First%20Name;Company would return the following
|
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 |
{ "listId":"l-ctx", "offset":0, "count":3, "headers":[ "_contact_id_", "E-mail Address", "First Name", "Company" ], "data":[ [ "l-ctx:a36", "remove209.162.194.106@db.justspam.org", "", "" ], [ "l-ctx:a38", "remove@db.justspam.org", "", "" ], [ "l-ctx:a3a", "Rob+Second@salzman.us", "Rob", "Second Contact" ] ] } |
Code Examples
The java code 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 62 63 64 65 |
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; import org.json.JSONArray; public class GetListByIDExample { static String BASE_URL = "https://restapi.actonsoftware.com/"; static String ACTON_USERNAME = "{your username}"; static String ACTON_PASSWORD = "{your password}"; static String CLIENT_ID = "{your client id/key}"; static String CLIENT_SECRET = "{your client secret}"; public static void main(String[] args) { try { String access_token = getAccessToken(); Unirest.setDefaultHeader("Authorization", "Bearer " + access_token); printListHeaders(); } catch (UnirestException e) { e.printStackTrace(); } } /** * This method uses Download a List endpoint * and prints all the headers of the List */ private static void printListHeaders() throws UnirestException { // Get the list with id "l-ctx" HttpResponse listResponse = Unirest.get(BASE_URL + "/api/1/list/l-ctx").asJson(); // Get headers as array JSONArray headers =listResponse.getBody().getObject().getJSONArray("headers"); // Iterate thorough all the headers and print for (int i=0;i<headers.length();i++) System.out.println(headers.getString(i)); } /** * This is an util 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"); } } |
