logo
EasyListing
Api reference/Lists

Get

📋 Get a Email List

The Get List endpoint retrieves details about a specific Email list.

📌 Endpoint

GET /fetch/list/:id/?count={Number_of_subs}&page={Page_of_subs}

🔑 Authentication

Include your API key in the request header:

EL_API_KEY: YOUR_SECRET_API_KEY

🔤 Query Parameters

ParameterTypeRequiredDescription
idString✅ YesThe unique email list id
countNumber❌ NoThe amount of subscribers to receive with the list data. (max: 25) -> defaults to 5
pageNumber❌ NoThe page of the selected subscribers -> defaults to 1

✅ Successful Response

{
	"error": null,
	"message": "Fetched list successfully",
	"ok": true,
	"totalPages": 2,
	"totalItems": 46,
	"list": {
		"name": "Testing waitlist",
		"description": "Test Descripton for waitlist in testing purposes. New settings page test",
		"id": "waitlist_39faa295-dbc7-4bcd-b179-c0fe55ff4d7d",
		"status": "Live",
		"maximumSignups": 100,
		"createdAt": "2025-03-14T19:16:24.798Z"
	},
	"subscribers": []
}

🔄 Returned Fields

FieldDescription
totalItemsTotal amount of subscribers in given list
totalPagesTotal amount of pages in given list
listInformation about given list
subscriberscount amount of subscribers on page page of given list

For further API details, check out the API Reference.

On this page