Contact Lists
Contact Lists
Contact Lists
Manage reusable target lists for monitors — list, create, and delete.
GET
Contact Lists
Documentation Index
Fetch the complete documentation index at: https://docs.encrata.com/llms.txt
Use this file to discover all available pages before exploring further.
Authentication
Requires an API key in theAuthorization header.
List all lists
GET /api/agent/lists
Filter lists by type. Valid values:
email, phone, domain, ip, company, darkweb.If omitted, returns all lists regardless of type.Example request
Response
Returns an array of list objects.Unique list identifier (UUID).
The list’s display name.
The type of targets in this list:
email, phone, domain, ip, company, or darkweb.Number of targets in the list.
ISO 8601 timestamp.
ISO 8601 timestamp of last modification.
Create a list
POST /api/agent/lists
A display name for the list.
The type of targets. Default:
email. Valid values: email, phone, domain, ip, company, darkweb.Initial targets to add (legacy field, works for all types).
Initial targets to add.
Example request
Response
Returns the created list object with status201.
Get a list
GET /api/agent/lists/{id}
Returns a single list by ID.
Delete a list
DELETE /api/agent/lists/{id}
Deletes a list and all its targets. Returns 204 No Content.
Manage list targets
List targets
GET /api/agent/lists/{id}/emails
Returns an array of target strings in the list.
Add targets
POST /api/agent/lists/{id}/emails
Targets to add. Duplicates are ignored.
Remove targets
DELETE /api/agent/lists/{id}/emails
Targets to remove from the list.