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 Catalogs API

Manage product catalogs and catalog items used for personalization and recommendation in campaigns.

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

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

This API exposes 17 operations across 8 paths, and defines 15 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.

17 operations 8 paths 15 schemas 5 DELETE6 GET1 PATCH2 POST3 PUT

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 Catalogs 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 17

Across 8 paths, the API surfaces 17 operations — 5 DELETE, 6 GET, 1 PATCH, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Catalogs 17
GET
/api/catalogs
Get catalog names
listCatalogs 2 params → 200400401
DELETE
/api/catalogs/{catalogName}
Delete a catalog
deleteCatalog 1 param → 200400401
POST
/api/catalogs/{catalogName}
Create a catalog
createCatalog 1 param → 200201400401500
GET
/api/catalogs/{catalogName}/fieldMappings
Get field mappings for a catalog
getFieldMappings 1 param → 200400401404
PUT
/api/catalogs/{catalogName}/fieldMappings
Set a catalog's field mappings (data types)
updateFieldTypes 1 param body → 200400401
DELETE
/api/catalogs/{catalogName}/items
Bulk delete catalog items
bulkDeleteCatalogItems 1 param body → 200202400401
GET
/api/catalogs/{catalogName}/items
Get the catalog items for a catalog
listCatalogItems 5 params → 200400401404500
POST
/api/catalogs/{catalogName}/items
Bulk create catalog items
bulkUpdateCatalogItems 1 param body → 200202400401404500
DELETE
/api/catalogs/{catalogName}/items/{itemId}
Delete a catalog item
deleteCatalogItem 2 params → 200202400401
GET
/api/catalogs/{catalogName}/items/{itemId}
Get a specific catalog item
getCatalogItem 2 params → 200400401404
PATCH
/api/catalogs/{catalogName}/items/{itemId}
Create or update a catalog item
partialUpdateCatalogItem 2 params body → 200202400401
PUT
/api/catalogs/{catalogName}/items/{itemId}
Create or replace a catalog item
indexCatalogItem 2 params body → 200202400401500
GET
/catalogs/{catalogName}
Get a catalog
getCatalog 1 param → 200401404
DELETE
/catalogs/{catalogName}
Delete a catalog
deleteCatalogsByCatalogName 1 param → 200401404
GET
/catalogs/{catalogName}/items
List items in a catalog
getCatalogsByCatalogNameItems 3 params → 200401404
PUT
/catalogs/{catalogName}/items/{itemId}
Create or replace a catalog item
createOrReplaceCatalogItem 2 params body → 200400401
DELETE
/catalogs/{catalogName}/items/{itemId}
Delete a catalog item
deleteCatalogsByCatalogNameItemsByItemId 2 params → 200401404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are CatalogItemWithProperties (5 properties), GetCatalogsResponse (4 properties), GetCatalogItemsResponse (4 properties), IterableApiResponse (3 properties). Each schema is shown below with its type and property counts.

CatalogItemWithProperties
object
5 properties 5 required
CatalogBulkDeleteRequest
object
1 property 1 required
JsObject
object
1 property 1 required
CatalogFieldDefinitionSerializedModel
object
3 properties 2 required
JsValue
object
CatalogIndexItemRequest
object
1 property 1 required
GetCatalogsResponse
object
4 properties 2 required
GetCatalogItemsResponse
object
4 properties 2 required
CatalogBulkUploadRequest
object
2 properties 2 required
IterableApiResponse
object
3 properties 2 required
CatalogUpdateItemRequest
object
1 property 1 required
CatalogFieldMappingsResponse
object
2 properties 2 required
CatalogName
object
1 property 1 required
CatalogMappingsUpdateRequest
object
1 property 1 required
IterableResponse
object
Standard Iterable API response indicating success or failure
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iterable-catalogs-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 Channels API
Iterable Commerce API
Iterable Email API
Iterable Events API
Iterable Experiments API
Iterable Lists API
Where this information came from

This is an independent, third-party profile of Iterable Catalogs 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.