Skip to main content
GET
/
api
/
v2
/
lists
cURL
curl "https://app.tatango.com/api/v2/lists" -X GET \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -u [email protected]:my_api_key \
  -H "Host: example.org" \
  -H "Cookie: "
{
  "status": "OK",
  "per_page": 10,
  "count": 3,
  "page": 1,
  "pages_count": 1,
  "lists": [
    {
      "id": 7,
      "name": "Mobile Campaign",
      "email_digest": "[email protected]",
      "email_subscribe": null,
      "email_unsubscribe": null,
      "first_optin_message": "",
      "second_optin_message": "",
      "message_help": null,
      "message_stop": null,
      "message_reply": null,
      "message_already_subscribed": null,
      "message_yes": null,
      "keyword_names": [],
      "counts": {
        "subscribers": 0,
        "unsubscribed": 0,
        "cleaned": 0
      },
      "opt_in_type": "single",
      "opt_in_requests": []
    },
    {
      "id": 8,
      "name": "Pizza Campaign",
      "email_digest": "[email protected]",
      "email_subscribe": null,
      "email_unsubscribe": null,
      "first_optin_message": "",
      "second_optin_message": "",
      "message_help": null,
      "message_stop": null,
      "message_reply": null,
      "message_already_subscribed": null,
      "message_yes": null,
      "keyword_names": [],
      "counts": {
        "subscribers": 0,
        "unsubscribed": 0,
        "cleaned": 0
      },
      "opt_in_type": "single",
      "opt_in_requests": []
    },
    {
      "id": 9,
      "name": "Pizza Campaign",
      "email_digest": "[email protected]",
      "email_subscribe": null,
      "email_unsubscribe": null,
      "first_optin_message": "",
      "second_optin_message": "",
      "message_help": null,
      "message_stop": null,
      "message_reply": null,
      "message_already_subscribed": null,
      "message_yes": null,
      "keyword_names": [
        "NEWHOTELS"
      ],
      "counts": {
        "subscribers": 0,
        "unsubscribed": 0,
        "cleaned": 0
      },
      "opt_in_type": "single",
      "opt_in_requests": []
    }
  ]
}

​
Request URL

GET https://app.tatango.com/api/v2/lists

Authorizations

​
Authorization
string
header
required

Tatango authenticates API requests by validating an API key passed via HTTP Basic Authentication. Use your login email as the username and your API key as the password.

Query Parameters

​
include_deleted
boolean
default:true

Whether to include deleted lists in the response. Defaults to true.

Response

200 - application/json

Successful response

​
status
string
required
Example:

"OK"

​
lists
object[]
required
​
per_page
integer
Example:

10

​
count
integer
Example:

3

​
page
integer
Example:

1

​
pages_count
integer
Example:

1