{ "item": [ { "id": "d6ca9dbc-e116-441a-a675-383958bd3355", "name": "Objects", "description": { "content": "Generic CRUD operations across Ontraport object types.", "type": "text/plain" }, "item": [ { "id": "9d1c3856-8658-488d-9d1f-b60e470c7bf4", "name": "List objects", "request": { "name": "List objects", "description": { "content": "Retrieves a collection of objects based on a set of parameters.", "type": "text/plain" }, "url": { "path": [ "objects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "objectID", "value": "", "description": "(Required) Numeric Ontraport object type ID (e.g. 0 = Contacts)." }, { "disabled": false, "key": "start", "value": "" }, { "disabled": false, "key": "range", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2a8fdb61-077f-47e9-8595-53ded459e043", "name": "Collection of objects response", "originalRequest": { "url": { "path": [ "objects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "objectID", "value": "" }, { "key": "start", "value": "" }, { "key": "range", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 3443,\n \"data\": [\n {\n \"key_0\": 7657.637471066172\n },\n {\n \"key_0\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30864056-e3e4-4138-859a-a4cecb2d2b00", "name": "Create object", "request": { "name": "Create object", "description": { "content": "Adds new data to your database.", "type": "text/plain" }, "url": { "path": [ "objects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"objectID\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"key_0\": \"string\",\n \"key_1\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "347458bb-feda-4200-aad3-6a7d619fd75a", "name": "Single object response", "originalRequest": { "url": { "path": [ "objects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"objectID\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"key_0\": true,\n \"key_1\": true,\n \"key_2\": \"string\",\n \"key_3\": 3883.1466218651544,\n \"key_4\": 3908\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 3105,\n \"data\": {\n \"key_0\": 8198\n },\n \"key_0\": \"string\",\n \"key_1\": 1408\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d02362d-276c-4333-a7e7-9e7193f8abe3", "name": "Update object", "request": { "name": "Update object", "description": { "content": "Updates existing object data.", "type": "text/plain" }, "url": { "path": [ "objects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"objectID\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"key_0\": \"string\",\n \"key_1\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e9cb0465-7417-4ea1-bbbe-73e8c93e01a0", "name": "Single object response", "originalRequest": { "url": { "path": [ "objects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"objectID\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"key_0\": true,\n \"key_1\": true,\n \"key_2\": \"string\",\n \"key_3\": 3883.1466218651544,\n \"key_4\": 3908\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 3105,\n \"data\": {\n \"key_0\": 8198\n },\n \"key_0\": \"string\",\n \"key_1\": 1408\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2133817d-776d-49e6-9373-35659878fcea", "name": "Delete object(s)", "request": { "name": "Delete object(s)", "description": { "content": "Permanently removes data from the database.", "type": "text/plain" }, "url": { "path": [ "objects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "objectID", "value": "", "description": "(Required) Numeric Ontraport object type ID (e.g. 0 = Contacts)." }, { "disabled": false, "key": "id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "0135ccd5-2be0-4cdb-ab01-81b62ff39637", "name": "Generic response", "originalRequest": { "url": { "path": [ "objects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "objectID", "value": "" }, { "key": "id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 1402\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e13be34a-853e-4679-b342-9b1235cc8598", "name": "Retrieve a single object by ID", "request": { "name": "Retrieve a single object by ID", "description": {}, "url": { "path": [ "object" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "objectID", "value": "", "description": "(Required) Numeric Ontraport object type ID (e.g. 0 = Contacts)." }, { "disabled": false, "key": "id", "value": "", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "803891d8-7a4e-46c9-b89f-cc1e381da273", "name": "Single object response", "originalRequest": { "url": { "path": [ "object" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "objectID", "value": "" }, { "key": "id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 3105,\n \"data\": {\n \"key_0\": 8198\n },\n \"key_0\": \"string\",\n \"key_1\": 1408\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ad59c92-5d6a-46ba-adcc-76c1204a0f39", "name": "Save or update object", "request": { "name": "Save or update object", "description": { "content": "Creates a new object or merges with an existing one if a unique field matches.", "type": "text/plain" }, "url": { "path": [ "objects", "saveorupdate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"objectID\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"key_0\": \"string\",\n \"key_1\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "af74a4ef-db04-48d1-8c63-a4c983213396", "name": "Single object response", "originalRequest": { "url": { "path": [ "objects", "saveorupdate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"objectID\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"key_0\": true,\n \"key_1\": true,\n \"key_2\": \"string\",\n \"key_3\": 3883.1466218651544,\n \"key_4\": 3908\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 3105,\n \"data\": {\n \"key_0\": 8198\n },\n \"key_0\": \"string\",\n \"key_1\": 1408\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5676830-ea2f-4b79-a54b-608d7a9afeb4", "name": "Retrieve objects by tag", "request": { "name": "Retrieve objects by tag", "description": {}, "url": { "path": [ "objects", "tag" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "objectID", "value": "", "description": "(Required) Numeric Ontraport object type ID (e.g. 0 = Contacts)." }, { "disabled": false, "key": "tag_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2b834eac-da49-496f-a063-810d8e3a6cd1", "name": "Collection of objects response", "originalRequest": { "url": { "path": [ "objects", "tag" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "objectID", "value": "" }, { "key": "tag_id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4829,\n \"data\": [\n {\n \"key_0\": 3850.8875138964536,\n \"key_1\": 3445.9026244955626\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"key_0\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb772b2c-f1fb-4311-a4bf-7017554bded6", "name": "Retrieve object ID by email", "request": { "name": "Retrieve object ID by email", "description": {}, "url": { "path": [ "object", "getByEmail" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "objectID", "value": "", "description": "(Required) Numeric Ontraport object type ID (e.g. 0 = Contacts)." }, { "disabled": false, "key": "email", "value": "", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "78f08531-da00-420d-a689-b93e5ca8f34a", "name": "Generic response", "originalRequest": { "url": { "path": [ "object", "getByEmail" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "objectID", "value": "" }, { "key": "email", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 1402\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dd5e606c-ab33-46e9-a8a4-db4ac4d90342", "name": "Metadata", "description": { "content": "Object metadata and field information.", "type": "text/plain" }, "item": [ { "id": "f5e7c66f-518a-408e-ad43-e2ef98301a2c", "name": "Retrieve object field metadata", "request": { "name": "Retrieve object field metadata", "description": {}, "url": { "path": [ "objects", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "objectID", "value": "", "description": "(Required) Numeric Ontraport object type ID (e.g. 0 = Contacts)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1902dedb-358a-46f8-a1e7-ab3c034cda08", "name": "Generic response", "originalRequest": { "url": { "path": [ "objects", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "objectID", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 1402\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "987b2218-0cd3-4523-9d2b-e6fffdcb3dfe", "name": "Retrieve collection info", "request": { "name": "Retrieve collection info", "description": { "content": "Returns collection information such as object counts.", "type": "text/plain" }, "url": { "path": [ "objects", "getInfo" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "objectID", "value": "", "description": "(Required) Numeric Ontraport object type ID (e.g. 0 = Contacts)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7449389c-640e-4f50-a694-e64019b8cd9d", "name": "Generic response", "originalRequest": { "url": { "path": [ "objects", "getInfo" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "objectID", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 1402\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d42c4265-2ee7-48ab-a68e-350f5a2a2ac3", "name": "Create custom fields and sections", "request": { "name": "Create custom fields and sections", "description": {}, "url": { "path": [ "objects", "fieldeditor" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"key_0\": 4419.51512510731\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e83b4a43-1446-49df-81e4-a4d6b9ae5216", "name": "Generic response", "originalRequest": { "url": { "path": [ "objects", "fieldeditor" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Api-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": 1402\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 1402\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.ontraport.com/1", "key": "baseUrl" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "info": { "_postman_id": "e63f6205-9143-4e36-bd71-05679aa473c8", "name": "Ontraport REST API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Ontraport's REST API exposes CRUD access to contacts, transactions, tags,\nsequences, forms, landing pages, and ecommerce objects. Authentication uses\n`Api-Key` and `Api-Appid` HTTP headers. All endpoints share a generic object\ninterface where the object type is specified via parameters.\n\n\nContact Support:\n Name: Ontraport Developer Documentation", "type": "text/plain" } } }