API resources

Outbox

The outbox (Postausgang) lists every e-mail and text message fepli sent: confirmations, waiting list notices, receipts, reminders. It's the one place to answer "did the family get the confirmation?".

All outbox endpoints need ROLE_ADMIN.

The sent message model

Name
uuid
Type
string
Description
The message's identifier.
Name
channel
Type
string
Description
email or sms.
Name
to
Type
string
Description
The recipient's e-mail address or phone number.
Name
toName
Type
string
Description
The recipient's name. E-mails only.
Name
from
Type
string
Description
The sender address. E-mails only.
Name
subject
Type
string
Description
The subject line. E-mails only.
Name
type
Type
string
Description
What kind of notification it was, such as attendance_confirmed or offer_cancelled. Messages without such a type, text messages included, carry the internal name of the message that triggered them.
Name
sentAt
Type
timestamp
Description
When the message was sent.
Name
deliveryStatus
Type
string
Description
What is known about the delivery, as reported by the mail provider: gesendet (sent), zugestellt (delivered), geoeffnet (opened), geklickt (a link was clicked) or bounce (bounced or dropped).
Name
bounced
Type
boolean
Description
Whether the message bounced. Dropped messages show deliveryStatus: bounce but bounced: false.
Name
accounts
Type
reference[]
Description
The accounts the message went to. Names are left out where personal data is masked.
Name
attendances
Type
string[]
Description
The UUIDs of the applications the message is about.
Name
offers
Type
reference[]
Description
The offers the message is about.
Name
conversation
Type
string
Description
The UUID of the comment thread the message belongs to, if it was sent from one.
Name
text
Type
string
Description
The plain-text body. Only when you retrieve a single message.

GET/sent-messages

List sent messages

Returns a page of sent messages, newest first, without their text.

Optional filters

Name
account
Type
string
Description
Only messages to this account (UUID or e-mail address).
Name
to
Type
string
Description
Only e-mails to exactly this address. Implies channel=email.
Name
attendance
Type
string
Description
Only messages about this application (UUID).
Name
offer
Type
string
Description
Only messages about this offer (UUID).
Name
channel
Type
string
Description
email or sms.
Name
since
Type
timestamp
Description
Only messages sent since this moment.
Name
page, itemsPerPage
Type
integer
Description
See Pagination.

Request

GET·/sent-messages

curl -G https://ferienpass-musterstadt.de/api/sent-messages \
  -H "Authorization: Bearer $FEPLI_TOKEN" \
  --data-urlencode "account=familie.mueller@example.org" \
  -d since=2026-09-01

Response

[
  {
    "uuid": "0192d0e8-4b5c-7d6e-8f7a-9b0c1d2e3f35",
    "channel": "email",
    "to": "familie.mueller@example.org",
    "toName": "Anna Müller",
    "from": "ferienpass@musterstadt.de",
    "subject": "Zusage: Fahrradtour durch den Stadtpark",
    "type": "attendance_confirmed",
    "sentAt": "2026-09-01T08:03:20+02:00",
    "deliveryStatus": "geoeffnet",
    "bounced": false,
    "accounts": [
      {
        "uuid": "0191c7b2-4d5e-7f60-8a1b-2c3d4e5f6a05",
        "name": "Anna Müller"
      }
    ],
    "attendances": ["0192d0e8-3a4b-7c5d-9e6f-7a8b9c0d1e07"],
    "offers": [
      {
        "uuid": "0192a4f1-6e3b-7c85-b1d2-8f4e6a9c3b03",
        "name": "Fahrradtour durch den Stadtpark",
        "alias": "fahrradtour-durch-den-stadtpark"
      }
    ]
  }
]

GET/sent-messages/{uuid}

Retrieve a sent message

Returns one sent message, including its plain-text body in text.

Request

GET·/sent-messages/{uuid}

curl https://ferienpass-musterstadt.de/api/sent-messages/0192d0e8-4b5c-7d6e-8f7a-9b0c1d2e3f35 \
  -H "Authorization: Bearer $FEPLI_TOKEN"

Response (excerpt)

{
  "uuid": "0192d0e8-4b5c-7d6e-8f7a-9b0c1d2e3f35",
  "channel": "email",
  "subject": "Zusage: Fahrradtour durch den Stadtpark",
  "…": "…",
  "text": "Hallo Anna Müller,\n\nLena hat einen Platz für „Fahrradtour durch den Stadtpark“ am 14.10.2026 …"
}