List contact lists

Request

curl -X GET 'https://app.mailyte.com/api/v1/contact-lists' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/contact-lists', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/contact-lists",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/contact-lists');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/contact-lists")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • dataarray<object>
    • objectstringcontact_list
    • idstring

      Unique identifier for the list.

    • namestring
    • descriptionstring

      Optional free text describing what the list is for. `null` means NONE — none was written — never "we did not include it": it is a column on the row already read and it is present in a list response as well as on a single list. Nothing in the send path reads it — it is stored and handed back for your own operators.

    • contact_countinteger

      EVERY member of the list, whatever their state. An unsubscribed contact is still a member — membership and deliverability are separate facts here, and removing somebody from a list is not how an unsubscribe is recorded. So a list of 500 with 40 unsubscribes still reports 500; the mailable subset is `GET /contacts?list_id=…` filtered on `state`. Never null: the count is either already on the model or taken live.

    • created_atstring
    • updated_atstring
  • pagination_metaany

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.