How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Iterable Lists API

Create and manage subscriber lists. Subscribe and unsubscribe users from lists. Retrieve list metadata and membership.

Iterable Lists API is one of 30 APIs that Iterable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include List. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 10 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://api.iterable.com/, https://api.iterable.com/api, https://api.eu.iterable.com/api.

12 operations 10 paths 12 schemas 1 DELETE5 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.iterable.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Iterable Lists API declares 2 security schemes for authenticating requests. An API key is passed in the header as Api-Key (api_key). An API key is passed in the header as Api-Key (apiKeyAuth).

  • apiKeyAuth — Iterable API key passed in the Api-Key header. API keys can be created and managed in the Iterable project settings.

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 1 DELETE, 5 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

lists 12
GET
/api/lists
Get lists
getLists → 200400401
POST
/api/lists
Create a static list
create body → 200400401
GET
/api/lists/getUsers
Get users in a list
getUsers 2 params → 200400401503
GET
/api/lists/previewUsers
Preview users in a list
getUsersPreview 3 params → 200400401503
POST
/api/lists/subscribe
Add subscribers to list
subscribe body → 200400401
POST
/api/lists/unsubscribe
Remove users from a list
unsubscribe body → 200400401
DELETE
/api/lists/{listId}
Delete a list
delete 1 param → 200400401409
GET
/api/lists/{listId}/size
Get count of users in list
getListCount 1 param → 200400401503
GET
/lists
Get all lists
listLists → 200401
POST
/lists
Create a list
createList body → 200400401
POST
/lists/subscribe
Subscribe users to a list
subscribeToList body → 200400401
POST
/lists/unsubscribe
Unsubscribe users from a list
unsubscribeFromList body → 200400401

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are FailedUserUpdates (10 properties), UserBulkUpdateListResponse (7 properties), ListDetails (6 properties), OptionalApiUser (5 properties). Each schema is shown below with its type and property counts.

IterableApiResponse
object
3 properties 2 required
UserBulkUpdateListResponse
object
7 properties 2 required
OptionalApiUser
object
5 properties
UnsubscribeRequest
object
4 properties 2 required
GetListsResponse
object
1 property 1 required
Unsubscriber
object
2 properties
FailedUserUpdates
object
10 properties
CreateListResponse
object
1 property 1 required
CreateListRequest
object
2 properties 1 required
ListDetails
object
6 properties 4 required
SubscribeRequest
object
3 properties 2 required
List
object
A subscriber list in Iterable
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iterable-lists-api-openapi.yml Raw ↑

Other APIs Iterable publishes across the network.

Iterable Export API
Iterable Web SDK
Iterable iOS SDK
Iterable Android SDK
Iterable React Native SDK
Iterable Campaigns API
Iterable Catalogs API
Iterable Channels API
Iterable Commerce API
Iterable Email API
Iterable Events API
Iterable Experiments API
Where this information came from

This is an independent, third-party profile of Iterable Lists API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.