{ "item": [ { "id": "d06bea6b-2a08-4b37-9a82-596b63d19cc4", "name": "Leads", "description": { "content": "Pre-qualified sales prospects.", "type": "text/plain" }, "item": [ { "id": "e25300eb-78c5-4ce7-99a8-9ec7a1bae4cb", "name": "List leads", "request": { "name": "List leads", "description": { "content": "Returns leads available to the authenticated user.", "type": "text/plain" }, "url": { "path": [ "v2", "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "" }, { "disabled": false, "key": "per_page", "value": "" }, { "disabled": false, "key": "sort_by", "value": "" }, { "disabled": false, "key": "ids", "value": "" }, { "disabled": false, "key": "creator_id", "value": "" }, { "disabled": false, "key": "owner_id", "value": "" }, { "disabled": false, "key": "source_id", "value": "" }, { "disabled": false, "key": "first_name", "value": "" }, { "disabled": false, "key": "last_name", "value": "" }, { "disabled": false, "key": "organization_name", "value": "" }, { "disabled": false, "key": "status", "value": "" }, { "disabled": false, "key": "email", "value": "" } ], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "b6a31eb2-04ac-4aaa-9a2f-54fd582ae860", "name": "List of leads", "originalRequest": { "url": { "path": [ "v2", "leads" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "per_page", "value": "" }, { "key": "sort_by", "value": "" }, { "key": "ids", "value": "" }, { "key": "creator_id", "value": "" }, { "key": "owner_id", "value": "" }, { "key": "source_id", "value": "" }, { "key": "first_name", "value": "" }, { "key": "last_name", "value": "" }, { "key": "organization_name", "value": "" }, { "key": "status", "value": "" }, { "key": "email", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e33db663-d1d2-40e3-8e69-29e0dbb0fbbf", "name": "Create a lead", "request": { "name": "Create a lead", "description": {}, "url": { "path": [ "v2", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"status\": \"\",\n \"source_id\": \"\",\n \"owner_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d109938b-178d-42db-a63b-d768e3d91553", "name": "Lead created", "originalRequest": { "url": { "path": [ "v2", "leads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"status\": \"\",\n \"source_id\": \"\",\n \"owner_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "db5751af-cacc-40b7-96db-9c38c07276a9", "name": "Retrieve a lead", "request": { "name": "Retrieve a lead", "description": {}, "url": { "path": [ "v2", "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "d3be3029-ca7d-44a6-b3fa-153b25e92f3c", "name": "Lead", "originalRequest": { "url": { "path": [ "v2", "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75551915-c7e5-4b1c-914f-9de1a332e05c", "name": "Update a lead", "request": { "name": "Update a lead", "description": {}, "url": { "path": [ "v2", "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"status\": \"\",\n \"source_id\": \"\",\n \"owner_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c41a7bfe-86b5-4449-9764-b64c7eb656d0", "name": "Lead updated", "originalRequest": { "url": { "path": [ "v2", "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"status\": \"\",\n \"source_id\": \"\",\n \"owner_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8447c1a-9927-44c6-98ed-4f667ec855c0", "name": "Delete a lead", "request": { "name": "Delete a lead", "description": {}, "url": { "path": [ "v2", "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "918af31e-d676-4e7c-8bab-d4d3e6325788", "name": "Lead deleted", "originalRequest": { "url": { "path": [ "v2", "leads", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b096deb-d976-4e2d-a721-b1c86e011e33", "name": "Upsert a lead", "request": { "name": "Upsert a lead", "description": {}, "url": { "path": [ "v2", "leads", "upsert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"status\": \"\",\n \"source_id\": \"\",\n \"owner_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0b17f4b9-50ab-4fa4-92c6-61ca4365d4d3", "name": "Lead created or updated", "originalRequest": { "url": { "path": [ "v2", "leads", "upsert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"status\": \"\",\n \"source_id\": \"\",\n \"owner_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.getbase.com", "key": "baseUrl" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "read write" }, { "key": "accessTokenUrl", "value": "https://api.getbase.com/oauth2/token" }, { "key": "authUrl", "value": "https://api.getbase.com/oauth2/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "info": { "_postman_id": "be64853d-7029-4b35-a6da-b2d5e6573d5b", "name": "Zendesk Sell (Sales CRM) Contacts Leads API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The Zendesk Sell Sales CRM API (formerly Base CRM) is a RESTful API hosted\nat api.getbase.com that provides programmatic CRUD access to Sell records\nincluding leads, contacts, deals, and other sales-pipeline resources. The\nSell platform also offers Sync, Firehose, and Search APIs alongside the\nCore API documented here. Authentication uses OAuth 2.0.\n\nContact Support:\n Name: Zendesk Developer Portal", "type": "text/plain" } } }