Sign in
latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Distribution Lists

Get all distribution lists

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Distribution%20Lists/getDistributionLists" target="_blank">Try in sandbox</a><br>

get/api/v2/distribution-lists

Query parameters

pageinteger

The current fetched page.

limitinteger

The number of results per page.

querystring

Find distribution lists by name or email.

orderBy'email' | 'name' | 'membersCount'

Order results by some field. Default is email.

direction'asc' | 'desc'

Order direction. Default is desc.

Response

Returned when successful.

pageinteger required
pageCountinteger required

The total number of pages.

limitinteger required

The number of results per page.

Example response

{
  "page": 1,
  "pageCount": 10,
  "limit": 10,
  "resources": [
    {
      "id": 715,
      "name": "Support alerts",
      "email": "ab12345678@distributionlists.textmagic.com",
      "membersCount": 332
    }
  ]
}