ELelasticemail
Lists

Load Lists

Returns all your existing lists. Required Access Level: ViewContacts

get/lists

Request

  • Base URL
    https://api.elasticemail.com/v4
  • URL
    https://api.elasticemail.com/v4/lists
  • Auth
    API key in header X-ElasticEmail-ApiKey

Query parameters

limitinteger

integer

Maximum number of returned items.

offsetinteger

integer

How many items should be returned ahead.

Response

OK

ListNamestring string

Name of your list.

PublicListIDstring guid nullable

ID code of list. Please note that this is different from the listid field.

DateAddedstring date-time

Date of creation in YYYY-MM-DDThh:ii:ss format

AllowUnsubscribeboolean

True: Allow unsubscribing from this list. Otherwise, false

Example response

[
  {
    "ListName": "My List 1",
    "PublicListID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
    "DateAdded": "2001-01-01T12:00:00"
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.