Skip to the documentation
API

Read out of office replies

Every out of office reply saved in the workspace, or the one of a single address.

GET/out-of-office

Runs the real call on your workspace.

GET /out-of-office

Every out of office reply saved in the workspace, or the one of a single address.

Example

Needs settings:read. Without address the list holds every reply saved in the workspace. With it the list holds exactly one row, which reads enabled: false with empty text and null dates when that address never saved a reply.

curl
curl "$OE/[email protected]" -H "$AUTH"
Response
{  "object": "list",  "data": [    {      "object": "out_of_office",      "address": "[email protected]",      "enabled": true,      "active": true,      "startsAt": "2026-12-22T00:00:00.000Z",      "endsAt": "2027-01-04T08:00:00.000Z",      "subject": "Away until 4 January",      "message": "I am away until 4 January and will answer when I am back.",      "contactsOnly": false,      "updatedAt": "2026-12-22T09:14:03.117Z"    }  ]}

address is one address, or *@acme.com for the catch-all of a domain. active says whether mail arriving now is answered: the reply is on, startsAt has passed and endsAt has not.

A key or an app limited to particular addresses or domains reaches only the addresses it holds, and a catch-all only when it holds the domain whole.

Reference