GET
/api/mailing-listsPublicList mailing lists
Public directory of mailing lists. Anonymous callers only see public lists; an optional admin bearer access token widens the listing to private ones.
operationId
listMailingListsMailing ListsAuthentication & permissionsPublic
Anyone — no credentials required
- Accepted credentials
- None required
- Notes
- An admin's bearer access token, when present, also lists private mailing lists.
Responses
application/json
| Property | Type | Description |
|---|---|---|
| success* | true | |
| data* | MailingList[] | |
| mailing_list_id* | string (uuid) | |
| name* | string | minLength: 3maxLength: 64 |
| description* | string | minLength: 3maxLength: 256 |
| public* | boolean | Whether the list is shown in the public mailing list directory. |
| created_at* | number | Creation time as a Unix timestamp in milliseconds. minimum: 0 |
JSONExample
"success"true
"data"
"mailing_list_id""b7d1f9c2-4a3e-4d24-9f6b-2f42f8f0a111"
"name""Product updates"
"description""Occasional announcements about new features."
"public"true
"created_at"1.5
Example request
bashcurl
curl -X GET 'https://mail.schemavaults.com/api/mailing-lists'