Download a list

Scott Wallace
Scott Wallace
  • Updated
GET https://api.actonsoftware.com/api/1/list/{listid}

This endpoint allows you to download a specific list from the account.

Customers wanting to access our API via our gateway in the EU can use this link: 

GET https://api-eu.actonsoftware.com/api/1/list/{listid}

Parameters

Name Parameter
Type
Allow
Multiple
Required/
Optional
Data Type Description
Authorization: Header False Required String Insert your generated access token.
("Bearer {access token}")
listid Path False Required String The ID of the list you would like to download.
count Query false optional String Specify the number of elements to fetch.
(Maximum=1000)
offset Query false Optional String Specify the element offset to begin the fetch.
(Default=0)
modbefore Query False Optional String Filter records modified before the specified date.
modafter Query False Optional String Filter records modified after the specified date.
createdbefore Query False Optional String Filter records created before the specified date.
createdafter Query False Optional String Filter records created after the specified date.
fields Query False Optional String Using a semicolon as the delimiter specify the fields (URLEncoded Required) you would like returned.

The query parameter "datequalifiers" cannot be used in conjunction with this option.
datequalifiers Query False Optional Boolean A "true" values return the dates created and modified. These columns will be headed with the names "__created_date" and "__modified_date".

The query parameter "fields" cannot be used in conjunction with this option.
responseformat Query False Optional String Specify the desired response format.
("JSON", "CSV")


Parameter Notes

responseformat

 

JSON in limited to 1,000 list members per API call and the number of fields is limited to 255.
CSV can return the entire list even if it is large and the number of fields in unlimited.

modbefore, modafter, createdbefore, createdafter, and datequalifiers

Please use Unix timestamps in milliseconds (timestamp converter: example).

 

Response

{ 
   "listId":"l-ctx",
   "offset":0,
   "count":1,
   "totalCount":1,
   "emailColumn":3,
   "headers":[ 
      "_contact_id_",
      "First Name",
      "Last Name",
      "E-mail Address"
   ],
   "data":[ 
      [ 
         "l-ctx:0,
         "John",
         "Doe",
         "john.doe@act-on.com"
      ]
   ]
}

 

Code Examples

cURL

curl -X GET https://api.actonsoftware.com/api/1/list/l-ctx -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs"

Was this article helpful?

0 out of 1 found this helpful

Have more questions? Submit a request