POST
Stable
List contacts
/v1/contacts/list
Supports search and simple AND-style filter clauses such as status, group, project, environment, last emailed, and suppression flags.
Request
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
search |
string | No | Search email or name. | |
filters |
array | No | Simple contact filter clauses. | |
pageSize |
number | No | Page size, capped by the API. | |
curl
curl -X POST 'https://api.emailsdone.dev/v1/contacts/list' \
-H 'Authorization: Bearer ed_...' \
-H 'Content-Type: application/json' \
-d '{}'
Response
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
ok |
boolean | Yes | True when contacts were read. | |
contacts |
array | Yes | Contact records. | |
{}
Errors
| Status | Code | Message |
|---|---|---|
| 400 | invalid_request |
Request body failed validation. |
| 401 | missing_api_key |
Authorization bearer token is missing. |
| 401 | invalid_api_key |
API key is invalid. |
| 403 | api_key_revoked |
API key has been revoked. |
| 404 | contact_not_found |
Contact was not found. |
| 405 | method_not_allowed |
Only POST is allowed. |
| 500 | internal |
Unexpected server error. |
Notes
- Contacts are tenant-level recipients for app email history, not CRM records.
- Existing environment API keys can access tenant contacts endpoints.