Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Iterable Metadata API

Store and retrieve key-value metadata tables for use in personalization and campaign logic.

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

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

This API exposes 5 operations across 2 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.

5 operations 2 paths 1 schemas 2 DELETE2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.iterable.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Iterable Metadata 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 5

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

Metadata 5

Store and retrieve key-value metadata tables for use in personalization and campaign logic.

GET
/metadata/{table}
Get metadata table keys
getMetadataTable 1 param → 200401404
DELETE
/metadata/{table}
Delete a metadata table
deleteMetadataTable 1 param → 200401
GET
/metadata/{table}/{key}
Get a metadata entry
getMetadataEntry 2 params → 200401404
PUT
/metadata/{table}/{key}
Create or update a metadata entry
putMetadataEntry 2 params body → 200400401
DELETE
/metadata/{table}/{key}
Delete a metadata entry
deleteMetadataEntry 2 params → 200401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is IterableResponse (3 properties). Each schema is shown below with its type and property counts.

IterableResponse
object
Standard Iterable API response indicating success or failure
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iterable-metadata-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 ExperimentMetrics API