list_contacts
List contacts.
The space’s global directory, independent of audiences: search, tags, membership, and unsubscribe or other effective block. Requires access to every inbox. Sends nothing.
Access
- Key: an Escouade Mail key with
read. - Space: any space, verified or not.
- Changes nothing: yes, it only reads.
- Safe to replay: yes.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | no | Search in the address, the name and the fields. |
label | string | no | Exact tag. |
audience_id | string | no | Limit to one of the space’s audiences. |
subscription | one of subscribed, unsubscribed, blocked | no | subscribed: no known block (not proof of consent). unsubscribed: unsubscribed. blocked: another effective block. |
offset | integer | no | Position to start from, for the next page. |
limit | integer | no | Number of contacts returned. |
Call it
curl -s https://api.subagent.fr/v1/list_contacts \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer sak_…' \
-d '{}'The full page in French, with the response fields and every refusal the tool can return: /mail/docs/reference/list_contacts.
This page in Markdown: /en/mail/docs/reference/list_contacts.md
All the docs for an agent: /en/mail/docs/llms.txt
Legal notice · Terms · Privacy · Service status