Skip to content

Reference / Distribution lists

List distribution lists

GET/api/v1/segments

The workspace's distribution lists with counts. The contacts in one are fetched with GET /contacts?segment_id=.

Scope

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

Response

200 All distribution lists.

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

Errors