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 23 APIs that Iterable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Lists. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 4 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.iterable.com/api, https://api.eu.iterable.com/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Iterable Lists API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Api-Key (apiKeyAuth).
By default, every request must be authenticated.
apiKeyAuth— Iterable API key passed in the Api-Key header. API keys can be created and managed in the Iterable project settings.
Paths & Operations 4
Across 3 paths, the API surfaces 4 operations — 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Create and manage subscriber lists. Subscribe and unsubscribe users from lists. Retrieve list metadata and membership.
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is List (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Iterable 12
Other APIs Iterable publishes across the network.