fepli
DevelopersAPI resources

Sent messages

The sent messages list the e-mails and text messages fepli sent: confirmations, waitlist notices, receipts, reminders. They're the one place to answer "did the family get the confirmation?".

All sent message endpoints need ROLE_ADMIN.

Sent messages older than the period set in the admin under Einstellungen → Datenschutz → Aufbewahrung, row E-Mails und SMS, counted from sending, are deleted, and then no longer appear here.

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. null for text messages and for e-mails sent before fepli recorded the type.

  • 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: sent, delivered or bounce (bounced or dropped). The provider's reports are recorded only while the tenant has switched on the app Versand nachverfolgen, which is off by default; without it the status stays sent. opened and clicked (a link was clicked) appear only where the app's setting Öffnungen und Klicks messen is on and the recipient may be measured.

  • 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 attendances 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. Links that would let the reader act as the recipient (sign-in, invitation, password, registration, consent and payment links) are replaced with ******, and so is the link behind the e-mail's main button. Messages stored before fepli replaced these links keep them.


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 within your own tenant).

  • Name
    to
    Type
    string
    Description

    Only e-mails to exactly this address. Implies channel=email.

  • Name
    attendance
    Type
    string
    Description

    Only messages about this attendance (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.

GET/sent-messages
curl -G https://example.fepli.eu/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@example.fepli.eu",
    "subject": "Zusage: Fahrradtour durch den Stadtpark",
    "type": "attendance_confirmed",
    "sentAt": "2026-09-01T08:03:20+02:00",
    "deliveryStatus": "delivered",
    "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.

GET/sent-messages/{uuid}
curl https://example.fepli.eu/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 …"
}

Was this page helpful?