Skip to content

Reference / Distribution lists

Get distribution list

GET/api/v1/segments/{id}

A distribution list with counts.

Scope

  • segments:read Read distribution lists – the person behind the key must be administrator.

Path parameters

idstringrequired
The distribution list's ID.

Response

200 The distribution list.

idstringrequired
namestringrequired
descriptionstring | nullrequired
matchingintegerrequired
Contacts that match the conditions right now (not deleted).
activeintegerrequired
Of those: active.
created_atstring (time, ISO 8601)required
When the list was created.
updated_atstring (time, ISO 8601)required
When the conditions were last changed.

Errors