v1

latestOpenAPI 3.0.02026-07-14106203730.9 KB

Mailing Lists

List Mailing Lists

Retrieve a list of mailing lists.

Returns a paginated list of mailing lists associated with the authenticated organization, filterable by various parameters.

get/print-mail/v1/mailing_lists

Query parameters

skipinteger

limitinteger

string

You can supply a structured search query instead of supplying unstructured text to any list endpoint help refine your search for a resource.

For example, let's say you created a series of letters that all had metadata: { campaignID: 'abc' }. You could search for all those letters by passing in { "metadata.campaignID": "abc" } into the search parameter.

Note that this string must be valid JSON.

You can supply any string to help narrow down the list of resources. For example, if you pass "New York" (quoted), it will return resources that have that string present somewhere in their response. Alternatively, you can supply a structured search query. See the documentation on StructuredSearchQuery for more details.

Response

A list object containing mailing lists.

object'list' required

totalCountinteger required

skipinteger required

limitinteger required