Lists
Keep people and companies in lists for campaigns and exports, or upload your own from a CSV.
Create, read, rename, empty, delete and export your contact and company lists from your own code. Every call takes listType: contact for people, company for companies. 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 |
curl -X GET "https://rest-dash.revealid.xyz/admin/lists?privateKey=YOUR_KEY&websiteId=64b7f0a1c2d3e4f5a6b7c8d9&listType=contact&page=1&limit=50"What each field accepts
| Field | Type | Limits and format | Accepted values |
|---|---|---|---|
| websiteId* | string | pattern ^[0-9a-fA-F]{24}$ | any |
| listType* | string | — | contactcompany |
| page | integer | whole number · default 1 | any |
| limit | integer | max 100 · whole number · default 50 | any |
| excludeListItems | string | default "false" | truefalse |
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. People are added to the list from the dashboard or a campaign.
Use case: Tidy up
DELETE /admin/lists/{id}/items removes people from a list (they stay in your account); DELETE /admin/lists/{id} deletes the list itself; PUT /v3/lists/{listId}/name renames it.