GET
/api/mailing-lists/subscribersAdminList a mailing list's subscribers
operationId
listSubscribersMailing ListsAuthentication & permissionsAdmin
Platform administrators only
- Accepted credentials
- Access token (Bearer)
Authorization: Bearer <JWT> - Access token (cookie)
cookie "access_token_schemavaults-mail"
- Access token (Bearer)
- Who may call
- Platform administrators only
Query parameters
| Name | Type | Description |
|---|---|---|
| mailing_list_id* | string (uuid) | ID of the mailing list whose subscribers to list. |
Responses
application/json
| Property | Type | Description |
|---|---|---|
| success* | true | |
| data* | MailingListSubscriber[] | |
| mailing_list_id* | string (uuid) | |
| subscribe_time* | number | Subscription time as a Unix timestamp in milliseconds. minimum: 0 |
| email* | string (email) |
JSONExample
"success"true
"data"
"mailing_list_id""123e4567-e89b-12d3-a456-426614174000"
"subscribe_time"1.5
"email""user@example.com"
Example request
bashcurl
curl -X GET 'https://mail.schemavaults.com/api/mailing-lists/subscribers?mailing_list_id=<mailing_list_id>' \
-H 'Authorization: Bearer <access_token>'