{ "info": { "_postman_id": "2366daa3-3821-4250-b80c-9227bcc22679", "name": "Iterable Export Campaigns Catalogs API", "description": "The Iterable Export API enables developers to extract data from Iterable projects for analytics, reporting, and data warehousing purposes. It provides export endpoints that allow retrieval of user data, event data, campaign metrics, and message engagement information in CSV and JSON formats. The export endpoints support filtering by date ranges and event types, making it possible to build custom reporting pipelines and synchronize Iterable data with external business intelligence tools.\n\nContact Support:\n Name: Iterable Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "lastUpdatedBy": "35240", "uid": "35240-2366daa3-3821-4250-b80c-9227bcc22679" }, "item": [ { "name": "catalogs", "item": [ { "name": "{catalogName}", "item": [ { "name": "items", "item": [ { "name": "{itemId}", "item": [ { "name": "Create or replace a catalog item", "id": "8d48aca2-00af-4f13-8d8b-163a91868c18", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": {\n \"nostrud03\": true,\n \"tempor_d\": 19428146,\n \"dolore2_\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/catalogs/:catalogName/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName", "items", ":itemId" ], "variable": [ { "id": "52dcba87-3f66-4111-af35-be3b5ac55274", "key": "catalogName", "value": "", "description": "(Required) The name of the catalog" }, { "id": "042a4b7d-eb6b-48f1-a215-712da8482faa", "key": "itemId", "value": "", "description": "(Required) The unique identifier for the catalog item" } ] }, "description": "Creates a new catalog item or replaces an existing one with the specified item ID and field values." }, "response": [ { "id": "5ae21ab5-3695-4658-97fc-041ccc83c5c6", "name": "Catalog item created or replaced", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": {\n \"nostrud03\": true,\n \"tempor_d\": 19428146,\n \"dolore2_\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/catalogs/:catalogName/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName", "items", ":itemId" ], "variable": [ { "key": "catalogName" }, { "key": "itemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"msg\": \"\",\n \"code\": \"\",\n \"params\": {\n \"eubb\": -82737047.7934747\n }\n}", "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-5ae21ab5-3695-4658-97fc-041ccc83c5c6" }, { "id": "96b971da-58a1-440c-983e-19e3bc666313", "name": "Bad request", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": {\n \"nostrud03\": true,\n \"tempor_d\": 19428146,\n \"dolore2_\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/catalogs/:catalogName/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName", "items", ":itemId" ], "variable": [ { "key": "catalogName" }, { "key": "itemId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-96b971da-58a1-440c-983e-19e3bc666313" }, { "id": "f44d311f-1242-47d6-961b-735e43c11e64", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": {\n \"nostrud03\": true,\n \"tempor_d\": 19428146,\n \"dolore2_\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/catalogs/:catalogName/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName", "items", ":itemId" ], "variable": [ { "key": "catalogName" }, { "key": "itemId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-f44d311f-1242-47d6-961b-735e43c11e64" } ], "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-8d48aca2-00af-4f13-8d8b-163a91868c18" }, { "name": "Delete a catalog item", "id": "70d400bf-383e-47ad-9490-b747dc8c6a08", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName", "items", ":itemId" ], "variable": [ { "id": "9680b7fc-e6fa-4bd3-a878-19e7543e1d90", "key": "catalogName", "value": "", "description": "(Required) The name of the catalog" }, { "id": "1969255b-488e-48f4-9b11-e9680b533172", "key": "itemId", "value": "", "description": "(Required) The unique identifier for the catalog item" } ] }, "description": "Deletes a catalog item by its item ID." }, "response": [ { "id": "89b7dd15-0445-4b8a-8064-b9fa4577c3eb", "name": "Catalog item deleted", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName", "items", ":itemId" ], "variable": [ { "key": "catalogName" }, { "key": "itemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"msg\": \"\",\n \"code\": \"\",\n \"params\": {\n \"eubb\": -82737047.7934747\n }\n}", "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-89b7dd15-0445-4b8a-8064-b9fa4577c3eb" }, { "id": "153892d0-08bd-4226-9bf1-47ca0cabd8df", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName", "items", ":itemId" ], "variable": [ { "key": "catalogName" }, { "key": "itemId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-153892d0-08bd-4226-9bf1-47ca0cabd8df" }, { "id": "d7522278-7824-4c8d-83c8-7e219ed960f5", "name": "Catalog item not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName", "items", ":itemId" ], "variable": [ { "key": "catalogName" }, { "key": "itemId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-d7522278-7824-4c8d-83c8-7e219ed960f5" } ], "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-70d400bf-383e-47ad-9490-b747dc8c6a08" } ], "id": "7871c27b-3a73-4220-b02b-08e89e1d1c03", "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-7871c27b-3a73-4220-b02b-08e89e1d1c03" }, { "name": "List items in a catalog", "id": "bafad8e7-e4f5-4b3b-b816-ed6258324db5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName/items?page=1&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName", "items" ], "query": [ { "description": "Page number for pagination", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "pageSize", "value": "100" } ], "variable": [ { "id": "9ed373e8-653e-4a2c-ae24-c6032296f1e6", "key": "catalogName", "value": "", "description": "(Required) The name of the catalog" } ] }, "description": "Retrieves items from a catalog with support for pagination." }, "response": [ { "id": "006b5ae0-4360-4169-8ebb-3fb7128e1bac", "name": "List of catalog items", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName/items?page=1&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName", "items" ], "query": [ { "description": "Page number for pagination", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "pageSize", "value": "100" } ], "variable": [ { "key": "catalogName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"params\": {\n \"catalogItemsWithProperties\": [\n {\n \"dolorec4\": true,\n \"esta8\": \"aute est non\",\n \"proident_14\": 58099729.76498559\n },\n {\n \"et_4\": 29215840,\n \"eiusmod_d\": 76952933\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-006b5ae0-4360-4169-8ebb-3fb7128e1bac" }, { "id": "bea58f3f-84d4-4b40-90cd-7e433832b1a4", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName/items?page=1&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName", "items" ], "query": [ { "description": "Page number for pagination", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "pageSize", "value": "100" } ], "variable": [ { "key": "catalogName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-bea58f3f-84d4-4b40-90cd-7e433832b1a4" }, { "id": "c190a38d-69d1-47c4-bb29-11af74c2eeda", "name": "Catalog not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName/items?page=1&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName", "items" ], "query": [ { "description": "Page number for pagination", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "pageSize", "value": "100" } ], "variable": [ { "key": "catalogName" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-c190a38d-69d1-47c4-bb29-11af74c2eeda" } ], "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-bafad8e7-e4f5-4b3b-b816-ed6258324db5" } ], "id": "ed88c2e5-f7c9-4cef-a141-7cfb06384608", "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-ed88c2e5-f7c9-4cef-a141-7cfb06384608" }, { "name": "Get a catalog", "id": "1bae0027-5525-4ac1-bf6b-db98d1ae451a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName" ], "variable": [ { "id": "12ecfaf8-ba12-4d0f-b981-890614b7b021", "key": "catalogName", "value": "", "description": "(Required) The name of the catalog" } ] }, "description": "Retrieves a catalog by name, including its field definitions and metadata." }, "response": [ { "id": "e69a6329-d426-4e06-b1f4-fc37bc3bc58e", "name": "Catalog data", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName" ], "variable": [ { "key": "catalogName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"params\": {\n \"catalogName\": \"\",\n \"fieldMappings\": {\n \"culpa84a\": -6650982,\n \"consequatf0\": \"dolore mollit id\",\n \"aliqua07\": 17278908\n }\n }\n}", "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-e69a6329-d426-4e06-b1f4-fc37bc3bc58e" }, { "id": "7fe09b3b-02b8-4843-9456-4d40dc5ea2d2", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName" ], "variable": [ { "key": "catalogName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-7fe09b3b-02b8-4843-9456-4d40dc5ea2d2" }, { "id": "f8d747dd-6159-4676-907c-94f224b6da26", "name": "Catalog not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName" ], "variable": [ { "key": "catalogName" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-f8d747dd-6159-4676-907c-94f224b6da26" } ], "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-1bae0027-5525-4ac1-bf6b-db98d1ae451a" }, { "name": "Delete a catalog", "id": "31848625-e068-43ce-a8f2-8fa3814412cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName" ], "variable": [ { "id": "0f384b52-c412-49db-8240-e3b82ca6585c", "key": "catalogName", "value": "", "description": "(Required) The name of the catalog" } ] }, "description": "Deletes a catalog and all its items from the Iterable project." }, "response": [ { "id": "182a61e5-49d6-4e54-a524-f29b7a21f0f3", "name": "Catalog deleted", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName" ], "variable": [ { "key": "catalogName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"msg\": \"\",\n \"code\": \"\",\n \"params\": {\n \"eubb\": -82737047.7934747\n }\n}", "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-182a61e5-49d6-4e54-a524-f29b7a21f0f3" }, { "id": "c92cf547-a645-4d60-96ca-1ca476ab2afc", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName" ], "variable": [ { "key": "catalogName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-c92cf547-a645-4d60-96ca-1ca476ab2afc" }, { "id": "2d6a41b7-5010-4d43-a7a6-7b21a86f5c28", "name": "Catalog not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/catalogs/:catalogName", "host": [ "{{baseUrl}}" ], "path": [ "catalogs", ":catalogName" ], "variable": [ { "key": "catalogName" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-2d6a41b7-5010-4d43-a7a6-7b21a86f5c28" } ], "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-31848625-e068-43ce-a8f2-8fa3814412cf" } ], "id": "b669d5e5-0a60-412d-94e5-341faf400e6d", "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-b669d5e5-0a60-412d-94e5-341faf400e6d" } ], "id": "bdfaaee7-ee6b-4f93-a7c3-ed39cffb0adf", "createdAt": "2026-07-28T01:59:22.000Z", "updatedAt": "2026-07-28T01:59:22.000Z", "uid": "35240-bdfaaee7-ee6b-4f93-a7c3-ed39cffb0adf" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Api-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.iterable.com/api" } ] }