Lists
Keep people and companies in lists for campaigns and exports, or upload your own from a CSV.
Authenticated with ?privateKey=YOUR_KEY (see Authentication).
| GET | /admin/lists | Get contact/company lists |
| POST | /admin/lists | Create new list |
| GET | /admin/lists/{id} | Get list with paginated items |
| DELETE | /admin/lists/{id} | Delete list |
| DELETE | /admin/lists/{id}/items | Remove items from list |
| POST | /admin/lists/export-csv/{listId} | Export list to CSV |
| PUT | /v3/lists/{listId}/name | Rename a list |
GET
Try:
Parameters
Website IdWebsite ID to get lists for
List TypeType of list to retrieve
PagePage number for pagination
LimitNumber of lists per page
Exclude List ItemsWhether to exclude list items from response
curl -X GET "https://rest-admin.happierleads.com/admin/lists?privateKey=YOUR_KEY&websiteId=64b7f0a1c2d3e4f5a6b7c8d9&listType=contact&page=1&limit=50"Response
Press Send request to try it with sample data.
Use case: Create a list and export it
POST /admin/lists?listType=contact with { "websiteId": …, "name": "Q4 founders" }, then POST /admin/lists/export-csv/{listId}?listType=contact — the file is emailed to you.