[BETA] Search the emails sent to an address, or those that did not arrive

post

https://ext.edusign.fr/v3/emails:search

The emails the platform sent for your school, most recent first, with whether each one arrived: those sent to one address (email), or with undelivered: true those that did not arrive, to one address, to some addresses or across the school. The history is kept three months; at most its 500 most recent matching emails are listed. The content of the emails is never returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

The recipient address, exactly as it was sent to (case included): the one on the student, teacher, external or user record. Required unless undelivered is true.

undelivered

boolean

Defaults to false

Only the emails that did not arrive: refused before sending (failed, dropped) or by the recipient server (bounced, blocked). Without email, lists those of the whole school. Defaults to false.

addresses

array of strings

With undelivered true and without email: only the emails sent to one of these addresses (1 to 1000), e.g. the members of a group. Matched whatever their case.

addresses

from

date-time

Only emails sent at or after this instant (ISO 8601).

date-time

Only emails sent at or before this instant (ISO 8601).

page

number

Defaults to 1

1-based page number for pagination. Defaults to 1.

limit

number

Defaults to 100

Number of results per page (max 100). Defaults to 100.

Responses

200Success

400Bad Request

401Unauthorized

403Forbidden

429Too Many Requests

500Internal Server Error

503Response