{ "info": { "name": "Geniziz API", "description": "The Geniziz REST API. Everything in the app is built on it, so anything you can do in the product you can automate.\n\n## Authentication\nSend your API key as HTTP Basic auth — the key is the **username**, the password is blank. Set the `api_key` collection variable once and every request inherits it. Create keys under Settings → API & Webhooks.\n\n```\ncurl -u YOUR_API_KEY: {{base_url}}/api/v1/me/\n```\n\n## Base URL\nThe `base_url` variable (defaults to your app domain).\n\n## IDs\nOpaque, prefixed strings — `lead_…`, `cont_…`, `oppo_…`, `acti_…`, `task_…`. Never assume a format beyond the prefix.\n\n## Responses & pagination\nSingle resources return the object. List endpoints return `{ \"data\": [ … ], \"has_more\": true|false }` and page with `_limit` (default 100, max 200) and `_skip` (offset).\n\n## Field selection\nAdd `_fields=id,name,date_created` to any read to trim the response.\n\n## Errors\nNon-2xx responses use `{ \"error\": \"message\", \"field-errors\": { \"field\": \"why\" } }` with a matching HTTP status (400 validation, 401 auth, 402 billing, 404 not found, 405 method, 429 rate limit).\n\n## Rate limits\nPer-endpoint-group limits with standard `ratelimit-*` response headers.\n\n## MCP\nThe same key authenticates the MCP server at `{{base_url}}/mcp/` (send a `Geniziz-Scope` header) for AI agents.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key}}", "type": "string" }, { "key": "password", "value": "", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://app.geniziz.com", "type": "string" }, { "key": "api_key", "value": "", "type": "string" } ], "item": [ { "name": "Activity", "item": [ { "name": "List activities", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "GET /activity/ — the unified stream, newest first." } }, { "name": "Note activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/note/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "note", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Note activity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/note/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "note", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/note/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "note", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update activity", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/note/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "note", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete activity", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/note/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "note", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } }, { "name": "Call activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/call/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "call", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Call activity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/call/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "call", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/call/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "call", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update activity", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/call/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "call", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete activity", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/call/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "call", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } }, { "name": "Channel message activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/channel_message/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "channel_message", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Channel message activity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/channel_message/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "channel_message", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/channel_message/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "channel_message", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update activity", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/channel_message/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "channel_message", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete activity", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/channel_message/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "channel_message", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } }, { "name": "Lead activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/status_change/lead/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "status_change", "lead", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Opportunity activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/status_change/opportunity/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "status_change", "opportunity", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Created activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/created/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "created", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Task completed activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/task_completed/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "task_completed", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Custom activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/custom/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "custom", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Custom activity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/custom/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "custom", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/custom/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "custom", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update activity", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/custom/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "custom", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete activity", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/custom/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "custom", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } }, { "name": "Email activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/email/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "email", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Email activity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/email/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "email", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/email/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "email", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update activity", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/email/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "email", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete activity", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/email/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "email", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } }, { "name": "SMS activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/sms/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "sms", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "SMS activity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/sms/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "sms", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/sms/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "sms", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update activity", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/sms/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "sms", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete activity", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/sms/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "sms", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } }, { "name": "Emailthread activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/emailthread/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "emailthread", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Get activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/emailthread/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "emailthread", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Meeting activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/meeting/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "meeting", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Meeting activity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/meeting/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "meeting", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/meeting/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "meeting", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update activity", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/activity/meeting/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "meeting", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete activity", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/activity/meeting/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "activity", "meeting", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "AI", "item": [ { "name": "Summarize lead ai", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/ai/summarize_lead/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "ai", "summarize_lead", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Draft email ai", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/ai/draft_email/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "ai", "draft_email", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Summarize conversation ai", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/ai/summarize_conversation/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "ai", "summarize_conversation", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Score lead ai", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/ai/score_lead/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "ai", "score_lead", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Suggest opportunity ai", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/ai/suggest_opportunity/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "ai", "suggest_opportunity", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Search ai", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/ai/search/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "ai", "search", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Extract tasks ai", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/ai/extract_tasks/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "ai", "extract_tasks", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "API Key", "item": [ { "name": "List api keys", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/api_key/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "api_key", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create api key", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/api_key/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "api_key", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete api key", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/api_key/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "api_key", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Automation", "item": [ { "name": "List automations", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/automation/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "automation", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create automation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/automation/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "automation", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get automation", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/automation/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "automation", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update automation", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/automation/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "automation", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete automation", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/automation/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "automation", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Bulk Action", "item": [ { "name": "List bulk actions", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/bulk_action/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "bulk_action", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Edit bulk action", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/bulk_action/edit/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "bulk_action", "edit", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete bulk action", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/bulk_action/delete/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "bulk_action", "delete", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Email bulk action", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/bulk_action/email/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "bulk_action", "email", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Sequence subscription bulk action", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/bulk_action/sequence_subscription/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "bulk_action", "sequence_subscription", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get bulk action", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/bulk_action/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "bulk_action", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update bulk action", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/bulk_action/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "bulk_action", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "PUT pause/resume.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Comment", "item": [ { "name": "List comments", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/comment/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "comment", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "GET /comment/ — exactly one of object_id= or thread_id=." } }, { "name": "Create comment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/comment/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "comment", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update comment", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/comment/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "comment", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete comment", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/comment/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "comment", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Tombstone; the thread disappears with its last comment." } } ] }, { "name": "Comment Thread", "item": [ { "name": "List comment threads", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/comment_thread/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "comment_thread", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Get comment thread", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/comment_thread/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "comment_thread", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } } ] }, { "name": "Connected Account", "item": [ { "name": "List connected accounts", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/connected_account/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "connected_account", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create connected account", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/connected_account/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "connected_account", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get connected account", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/connected_account/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "connected_account", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update connected account", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/connected_account/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "connected_account", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete connected account", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/connected_account/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "connected_account", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Contact", "item": [ { "name": "Merge contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact/merge/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", "merge", "" ] }, "description": "POST /contact/merge/ {source, destination}: the source's activities,\nconversations, enrollments, and files move to the destination, its\nemails/phones/urls are unioned in, and the source is deleted.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Share bulk contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact/share_bulk/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", "share_bulk", "" ] }, "description": "POST /contact/share_bulk/ {organization_id, all|query|contact_ids} —\nqueue a worker job sharing many contacts (e.g. an entire customer\nbase into a sister product's workspace).", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Share bulk contact", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/contact/share_bulk/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", "share_bulk", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "GET /contact/share_bulk/ — recent jobs; GET .../{id}/ — one job." } }, { "name": "Get contact", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/contact/share_bulk/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", "share_bulk", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "List contacts", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/contact/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "response": [ { "name": "200 Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/contact/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"cont_7h8i9j0k1l2m3n4o5p6q7r\",\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"name\": \"Connie Carter\",\n \"title\": \"VP Sales\",\n \"emails\": [\n {\n \"email\": \"connie@acme.example\",\n \"type\": \"direct\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"+15557654321\",\n \"type\": \"mobile\"\n }\n ],\n \"tags\": [\n \"champion\"\n ],\n \"date_created\": \"2026-01-15T09:31:00.000Z\"\n }\n ],\n \"has_more\": false\n}" } ] }, { "name": "Create contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"name\": \"Connie Carter\",\n \"title\": \"VP Sales\",\n \"emails\": [\n {\n \"email\": \"connie@acme.example\",\n \"type\": \"direct\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"+15557654321\",\n \"type\": \"mobile\"\n }\n ],\n \"tags\": [\n \"champion\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Example", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"name\": \"Connie Carter\",\n \"title\": \"VP Sales\",\n \"emails\": [\n {\n \"email\": \"connie@acme.example\",\n \"type\": \"direct\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"+15557654321\",\n \"type\": \"mobile\"\n }\n ],\n \"tags\": [\n \"champion\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cont_7h8i9j0k1l2m3n4o5p6q7r\",\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"name\": \"Connie Carter\",\n \"title\": \"VP Sales\",\n \"emails\": [\n {\n \"email\": \"connie@acme.example\",\n \"type\": \"direct\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"+15557654321\",\n \"type\": \"mobile\"\n }\n ],\n \"tags\": [\n \"champion\"\n ],\n \"date_created\": \"2026-01-15T09:31:00.000Z\"\n}" } ] }, { "name": "Share contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact/:id/share/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", ":id", "share", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "POST /contact/{id}/share/ {organization_id, lead_id?}", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Unshare contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact/:id/unshare/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", ":id", "unshare", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "POST /contact/{id}/unshare/ {organization_id} — sever the link to one\nworkspace. The contact there stays as an independent copy (nothing is\ndeleted); it just stops syncing with the person. Passing the current\nworkspace detaches THIS contact instead — useful when the person is\nshared with workspaces you cannot administer. When only one linked\ncontact remains, the share dissolves entirely.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enrich contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact/:id/enrich/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", ":id", "enrich", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "POST /contact/{id}/enrich/ — queue a job for the worker.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Shares contact", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/contact/:id/shares/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", ":id", "shares", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "GET /contact/{id}/shares/ — where else this person exists." } }, { "name": "Get contact", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/contact/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "response": [ { "name": "200 Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/contact/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cont_7h8i9j0k1l2m3n4o5p6q7r\",\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"name\": \"Connie Carter\",\n \"title\": \"VP Sales\",\n \"emails\": [\n {\n \"email\": \"connie@acme.example\",\n \"type\": \"direct\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"+15557654321\",\n \"type\": \"mobile\"\n }\n ],\n \"tags\": [\n \"champion\"\n ],\n \"date_created\": \"2026-01-15T09:31:00.000Z\"\n}" } ] }, { "name": "Update contact", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete contact", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/contact/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Contact List", "item": [ { "name": "List contact lists", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/contact_list/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact_list", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create contact list", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact_list/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact_list", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Copy getsales contact list", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact_list/copy_getsales/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact_list", "copy_getsales", "" ] }, "description": "POST /contact_list/copy_getsales/ {name} — materialize a read-only\nGetSales list as an internal one: every contact whose synced profile\nreferences that list becomes a member. Idempotent; re-copy adds\nnewly synced members.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update contact list", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact_list/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact_list", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "PUT /contact_list/{id}/ {name} — rename.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete contact list", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/contact_list/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact_list", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } }, { "name": "Members contact list", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact_list/:id/members/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact_list", ":id", "members", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "POST /contact_list/{id}/members/ {contact_ids: [...]}", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete contact list", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/contact_list/:id/members/:contact_id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact_list", ":id", "members", ":contact_id", "" ], "variable": [ { "key": "id", "value": "" }, { "key": "contact_id", "value": "" } ] }, "description": "DELETE /contact_list/{id}/members/{contact_id}/" } } ] }, { "name": "Contact Tag", "item": [ { "name": "List contact tags", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/contact_tag/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact_tag", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create contact tag", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact_tag/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact_tag", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update contact tag", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/contact_tag/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact_tag", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "PUT /contact_tag/{id}/ {name} — rename everywhere it is used.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete contact tag", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/contact_tag/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "contact_tag", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "DELETE /contact_tag/{id}/ — strip from every contact, drop the registry row." } } ] }, { "name": "Conversation", "item": [ { "name": "List conversations", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/conversation/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "conversation", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create conversation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/conversation/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "conversation", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get conversation", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/conversation/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "conversation", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update conversation", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/conversation/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "conversation", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete conversation", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/conversation/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "conversation", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Soft delete: hide the thread but keep its messages attached." } }, { "name": "Restore conversation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/conversation/:id/restore/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "conversation", ":id", "restore", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "POST /conversation/{id}/restore/ — undo a soft delete.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Message conversation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/conversation/:id/message/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "conversation", ":id", "message", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "POST /conversation/{id}/message/ — add a message into the thread.\n{type: note|email|sms, ...} — emails/SMS run through the real message\nstate machine (draft by default; \"outbox\" sends); recipients default\nto the conversation's contact.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Credentials", "item": [ { "name": "List credentialses", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/credentials/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "credentials", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update credentials", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/credentials/:service/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "credentials", ":service", "" ], "variable": [ { "key": "service", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete credentials", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/credentials/:service/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "credentials", ":service", "" ], "variable": [ { "key": "service", "value": "" } ] }, "description": "" } } ] }, { "name": "Custom Activity", "item": [ { "name": "List custom activities", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/custom_activity/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_activity", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create custom activity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/custom_activity/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_activity", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get custom activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/custom_activity/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_activity", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update custom activity", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/custom_activity/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_activity", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete custom activity", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/custom_activity/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_activity", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Custom Field", "item": [ { "name": "Get custom field", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/custom_field/:object_type/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_field", ":object_type", "" ], "variable": [ { "key": "object_type", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Post custom field", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/custom_field/:object_type/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_field", ":object_type", "" ], "variable": [ { "key": "object_type", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get custom field", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/custom_field/:object_type/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_field", ":object_type", ":id", "" ], "variable": [ { "key": "object_type", "value": "" }, { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update custom field", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/custom_field/:object_type/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_field", ":object_type", ":id", "" ], "variable": [ { "key": "object_type", "value": "" }, { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete custom field", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/custom_field/:object_type/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_field", ":object_type", ":id", "" ], "variable": [ { "key": "object_type", "value": "" }, { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Custom Field Schema", "item": [ { "name": "List custom field schemas", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/custom_field_schema/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_field_schema", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "GET /custom_field_schema/?object_type=lead" } } ] }, { "name": "Custom Object", "item": [ { "name": "List custom objects", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/custom_object/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_object", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create custom object", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/custom_object/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_object", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get custom object", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/custom_object/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_object", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update custom object", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/custom_object/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_object", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete custom object", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/custom_object/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_object", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Custom Object Type", "item": [ { "name": "List custom object types", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/custom_object_type/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_object_type", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create custom object type", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/custom_object_type/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_object_type", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get custom object type", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/custom_object_type/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_object_type", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update custom object type", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/custom_object_type/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_object_type", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete custom object type", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/custom_object_type/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_object_type", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Data", "item": [ { "name": "Search data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/data/search/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "data", "search", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"query\": {\n \"type\": \"object_type\",\n \"object_type\": \"lead\"\n },\n \"_limit\": 20\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 Example", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/data/search/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "data", "search", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"query\": {\n \"type\": \"object_type\",\n \"object_type\": \"lead\"\n },\n \"_limit\": 20\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"name\": \"Acme Inc\",\n \"url\": \"https://acme.example\",\n \"status_id\": \"stat_1a2b3c4d5e6f7g8h9i0j1k\",\n \"emails\": [\n {\n \"email\": \"hello@acme.example\",\n \"type\": \"office\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"+15551234567\",\n \"type\": \"office\"\n }\n ],\n \"mrr\": 4900,\n \"date_created\": \"2026-01-15T09:30:00.000Z\",\n \"date_updated\": \"2026-01-15T09:30:00.000Z\"\n }\n ],\n \"has_more\": false\n}" } ] } ] }, { "name": "Dialer", "item": [ { "name": "Token dialer", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/dialer/token/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "dialer", "token", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Call dialer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/dialer/call/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "dialer", "call", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List dialers", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/dialer/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "dialer", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create dialer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/dialer/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "dialer", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get dialer", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/dialer/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "dialer", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update dialer", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/dialer/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "dialer", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "PUT pause/resume/done.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Next dialer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/dialer/:id/next/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "dialer", ":id", "next", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "The dialer's heartbeat: next lead with a dialable contact; advances\nthe cursor. {\"done\": true} when the view is exhausted.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Email Template", "item": [ { "name": "List email templates", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/email_template/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "email_template", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create email template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/email_template/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "email_template", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get email template", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/email_template/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "email_template", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update email template", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/email_template/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "email_template", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete email template", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/email_template/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "email_template", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } }, { "name": "Render email template", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/email_template/:id/render/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "email_template", ":id", "render", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "GET /email_template/{id}/render/?lead_id=&contact_id=" } } ] }, { "name": "Enrichment", "item": [ { "name": "List enrichments", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/enrichment/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "enrichment", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Get enrichment", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/enrichment/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "enrichment", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } } ] }, { "name": "Event", "item": [ { "name": "List events", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/event/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "event", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Get event", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/event/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "event", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } } ] }, { "name": "Export", "item": [ { "name": "Lead export", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/export/lead/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "export", "lead", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Opportunity export", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/export/opportunity/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "export", "opportunity", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get export", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/export/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "export", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Download export", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/export/:id/download/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "export", ":id", "download", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } } ] }, { "name": "File", "item": [ { "name": "List files", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/file/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "file", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create file", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/file/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "file", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get file", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/file/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "file", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Download file", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/file/:id/download/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "file", ":id", "download", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Delete file", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/file/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "file", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Goal", "item": [ { "name": "List goals", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/goal/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "goal", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create goal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/goal/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "goal", "" ] }, "description": "POST /goal/ — upsert on (period, user_id). Admin-only.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete goal", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/goal/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "goal", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Group", "item": [ { "name": "List groups", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/group/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "group", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/group/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "group", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update group", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/group/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "group", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete group", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/group/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "group", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Import", "item": [ { "name": "List imports", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/import/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "import", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create import", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/import/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "import", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Presets import", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/import/presets/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "import", "presets", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "GET /import/presets/ — canned competitor mappings + valid targets." } }, { "name": "Get import", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/import/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "import", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update import", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/import/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "import", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "PUT /import/{id}/ — set the mapping on a draft and queue it.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Inbox Folder", "item": [ { "name": "List inbox folders", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/inbox_folder/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "inbox_folder", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create inbox folder", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/inbox_folder/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "inbox_folder", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update inbox folder", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/inbox_folder/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "inbox_folder", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete inbox folder", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/inbox_folder/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "inbox_folder", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Inbox Prospect", "item": [ { "name": "List inbox prospects", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/inbox_prospect/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "inbox_prospect", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Convert inbox prospect", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/inbox_prospect/:id/convert/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "inbox_prospect", ":id", "convert", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "POST /inbox_prospect/{id}/convert/ — lead + contact + the message.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Dismiss inbox prospect", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/inbox_prospect/:id/dismiss/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "inbox_prospect", ":id", "dismiss", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "POST /inbox_prospect/{id}/dismiss/", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Inbox Rule", "item": [ { "name": "List inbox rules", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/inbox_rule/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "inbox_rule", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create inbox rule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/inbox_rule/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "inbox_rule", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update inbox rule", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/inbox_rule/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "inbox_rule", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete inbox rule", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/inbox_rule/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "inbox_rule", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Integration Link", "item": [ { "name": "List integration links", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/integration_link/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "integration_link", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create integration link", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/integration_link/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "integration_link", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get integration link", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/integration_link/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "integration_link", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update integration link", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/integration_link/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "integration_link", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete integration link", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/integration_link/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "integration_link", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Lead", "item": [ { "name": "List leads", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/lead/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "lead", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "response": [ { "name": "200 Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/lead/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "lead", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"name\": \"Acme Inc\",\n \"url\": \"https://acme.example\",\n \"status_id\": \"stat_1a2b3c4d5e6f7g8h9i0j1k\",\n \"emails\": [\n {\n \"email\": \"hello@acme.example\",\n \"type\": \"office\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"+15551234567\",\n \"type\": \"office\"\n }\n ],\n \"mrr\": 4900,\n \"date_created\": \"2026-01-15T09:30:00.000Z\",\n \"date_updated\": \"2026-01-15T09:30:00.000Z\"\n }\n ],\n \"has_more\": false\n}" } ] }, { "name": "Create lead", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/lead/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "lead", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Inc\",\n \"url\": \"https://acme.example\",\n \"industry\": \"Software\",\n \"status_id\": \"stat_1a2b3c4d5e6f7g8h9i0j1k\",\n \"owner_id\": \"user_0a1b2c3d4e5f6g7h8i9j0k\",\n \"mrr\": 4900,\n \"emails\": [\n {\n \"email\": \"hello@acme.example\",\n \"type\": \"office\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"+15551234567\",\n \"type\": \"office\"\n }\n ],\n \"addresses\": [\n {\n \"city\": \"Austin\",\n \"country\": \"US\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Example", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/lead/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "lead", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Inc\",\n \"url\": \"https://acme.example\",\n \"industry\": \"Software\",\n \"status_id\": \"stat_1a2b3c4d5e6f7g8h9i0j1k\",\n \"owner_id\": \"user_0a1b2c3d4e5f6g7h8i9j0k\",\n \"mrr\": 4900,\n \"emails\": [\n {\n \"email\": \"hello@acme.example\",\n \"type\": \"office\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"+15551234567\",\n \"type\": \"office\"\n }\n ],\n \"addresses\": [\n {\n \"city\": \"Austin\",\n \"country\": \"US\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"name\": \"Acme Inc\",\n \"url\": \"https://acme.example\",\n \"status_id\": \"stat_1a2b3c4d5e6f7g8h9i0j1k\",\n \"emails\": [\n {\n \"email\": \"hello@acme.example\",\n \"type\": \"office\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"+15551234567\",\n \"type\": \"office\"\n }\n ],\n \"mrr\": 4900,\n \"date_created\": \"2026-01-15T09:30:00.000Z\",\n \"date_updated\": \"2026-01-15T09:30:00.000Z\"\n}" } ] }, { "name": "Merge lead", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/lead/merge/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "lead", "merge", "" ] }, "description": "POST /lead/merge/ {source, destination}: children move to the\ndestination, the source lead is deleted.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Move lead", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/lead/:id/move/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "lead", ":id", "move", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "POST /lead/{id}/move/ {target_organization_id}: move a lead and all\nits records into another workspace the caller administers. Org-scoped\nreferences that don't exist in the target are remapped to defaults\n(lead/opportunity status) or cleared (owner, assignee, custom fields),\nso the lead lands valid. The caller must be an admin of both\nworkspaces.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get lead", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/lead/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "lead", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "response": [ { "name": "200 Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/lead/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "lead", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"name\": \"Acme Inc\",\n \"url\": \"https://acme.example\",\n \"status_id\": \"stat_1a2b3c4d5e6f7g8h9i0j1k\",\n \"emails\": [\n {\n \"email\": \"hello@acme.example\",\n \"type\": \"office\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"+15551234567\",\n \"type\": \"office\"\n }\n ],\n \"mrr\": 4900,\n \"date_created\": \"2026-01-15T09:30:00.000Z\",\n \"date_updated\": \"2026-01-15T09:30:00.000Z\"\n}" } ] }, { "name": "Update lead", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/lead/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "lead", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Incorporated\",\n \"status_id\": \"stat_won0000000000000000000\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 Example", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/lead/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "lead", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Incorporated\",\n \"status_id\": \"stat_won0000000000000000000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"Acme Incorporated\",\n \"id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"url\": \"https://acme.example\",\n \"status_id\": \"stat_1a2b3c4d5e6f7g8h9i0j1k\",\n \"emails\": [\n {\n \"email\": \"hello@acme.example\",\n \"type\": \"office\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"+15551234567\",\n \"type\": \"office\"\n }\n ],\n \"mrr\": 4900,\n \"date_created\": \"2026-01-15T09:30:00.000Z\",\n \"date_updated\": \"2026-01-15T09:30:00.000Z\"\n}" } ] }, { "name": "Delete lead", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/lead/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "lead", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Mailing Export", "item": [ { "name": "List mailing exports", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/mailing_export/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "mailing_export", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create mailing export", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/mailing_export/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "mailing_export", "" ] }, "description": "POST /mailing_export/ {platform, filters{...}, config{...}}. Dry-runs\nthe audience so the caller sees the match count immediately, then\nqueues the push for the worker.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Platforms mailing export", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/mailing_export/platforms/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "mailing_export", "platforms", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "GET /mailing_export/platforms/ — the registry as the UI needs it:\neach platform with its config fields and whether its credential is\nconnected for this workspace." } }, { "name": "Get mailing export", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/mailing_export/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "mailing_export", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } } ] }, { "name": "Me", "item": [ { "name": "Get current user", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/me/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "me", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "response": [ { "name": "200 Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/me/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "me", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"user_0a1b2c3d4e5f6g7h8i9j0k\",\n \"email\": \"you@acme.example\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Rivera\",\n \"organizations\": [\n {\n \"id\": \"orga_3c4d5e6f7g8h9i0j1k2l3m\",\n \"name\": \"Acme Inc\"\n }\n ]\n}" } ] }, { "name": "Update current user", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/me/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "me", "" ] }, "description": "PUT /me/ — the user edits their own profile (name, signature).", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Membership", "item": [ { "name": "List memberships", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/membership/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "membership", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create membership", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/membership/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "membership", "" ] }, "description": "POST /membership/ {email, role_id?}: invite by email — creates the user\nwhen no account exists (they set a password via reset once email lands\nin Phase 6; until then an admin shares an API key).", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update membership", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/membership/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "membership", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete membership", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/membership/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "membership", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Notification", "item": [ { "name": "List notifications", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/notification/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notification", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update notification", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/notification/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notification", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "PUT /notification/{id}/ — mark (un)read; own notifications only.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark all read notification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/notification/mark_all_read/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notification", "mark_all_read", "" ] }, "description": "POST /notification/mark_all_read/", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "OAuth App", "item": [ { "name": "List oauth apps", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/oauth_app/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "oauth_app", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create oauth app", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/oauth_app/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "oauth_app", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete oauth app", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/oauth_app/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "oauth_app", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Opportunity", "item": [ { "name": "List opportunities", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/opportunity/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "opportunity", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "response": [ { "name": "200 Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/opportunity/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "opportunity", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"oppo_5e6f7g8h9i0j1k2l3m4n5o\",\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"status_id\": \"stat_pipe000000000000000000\",\n \"value\": 1200000,\n \"value_period\": \"annual\",\n \"value_formatted\": \"$12,000.00\",\n \"confidence\": 60,\n \"note\": \"Evaluating the Scale plan for 40 reps.\",\n \"date_created\": \"2026-01-15T09:32:00.000Z\"\n }\n ],\n \"has_more\": false\n}" } ] }, { "name": "Create opportunity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/opportunity/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "opportunity", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"status_id\": \"stat_pipe000000000000000000\",\n \"value\": 1200000,\n \"value_period\": \"annual\",\n \"confidence\": 60,\n \"note\": \"Evaluating the Scale plan for 40 reps.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Example", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/opportunity/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "opportunity", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"status_id\": \"stat_pipe000000000000000000\",\n \"value\": 1200000,\n \"value_period\": \"annual\",\n \"confidence\": 60,\n \"note\": \"Evaluating the Scale plan for 40 reps.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"oppo_5e6f7g8h9i0j1k2l3m4n5o\",\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"status_id\": \"stat_pipe000000000000000000\",\n \"value\": 1200000,\n \"value_period\": \"annual\",\n \"value_formatted\": \"$12,000.00\",\n \"confidence\": 60,\n \"note\": \"Evaluating the Scale plan for 40 reps.\",\n \"date_created\": \"2026-01-15T09:32:00.000Z\"\n}" } ] }, { "name": "Get opportunity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/opportunity/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "opportunity", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "response": [ { "name": "200 Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/opportunity/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "opportunity", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"oppo_5e6f7g8h9i0j1k2l3m4n5o\",\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"status_id\": \"stat_pipe000000000000000000\",\n \"value\": 1200000,\n \"value_period\": \"annual\",\n \"value_formatted\": \"$12,000.00\",\n \"confidence\": 60,\n \"note\": \"Evaluating the Scale plan for 40 reps.\",\n \"date_created\": \"2026-01-15T09:32:00.000Z\"\n}" } ] }, { "name": "Update opportunity", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/opportunity/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "opportunity", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete opportunity", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/opportunity/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "opportunity", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } }, { "name": "Line item opportunity", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/opportunity/:id/line_item/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "opportunity", ":id", "line_item", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Line item opportunity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/opportunity/:id/line_item/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "opportunity", ":id", "line_item", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete opportunity", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/opportunity/:id/line_item/:item_id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "opportunity", ":id", "line_item", ":item_id", "" ], "variable": [ { "key": "id", "value": "" }, { "key": "item_id", "value": "" } ] }, "description": "" } } ] }, { "name": "Organization", "item": [ { "name": "Create organization", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/organization/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "organization", "" ] }, "description": "POST /organization/ — create an additional workspace for the signed-in\nuser. The caller becomes its admin and gets the same structural defaults\nas bin/bootstrap provisions. The workspace bills under an account the\nuser owns: pass `account_id` to choose, or it defaults to their account\n(required when they own more than one).", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get organization", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/organization/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "organization", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update organization", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/organization/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "organization", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete organization", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/organization/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "organization", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "DELETE /organization/{id}/ — delete the CURRENT workspace and all\nits data (genizizcrm extension). Admin only; refused while it is the\ncaller's only workspace, so nobody locks themselves out. Stored\nfiles are removed from disk; orphaned shared-person rows dissolve." } } ] }, { "name": "Phone Number", "item": [ { "name": "Available phone number", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/phone_number/available/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "phone_number", "available", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "List phone numbers", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/phone_number/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "phone_number", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create phone number", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/phone_number/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "phone_number", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get phone number", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/phone_number/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "phone_number", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update phone number", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/phone_number/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "phone_number", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete phone number", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/phone_number/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "phone_number", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Pipeline", "item": [ { "name": "List pipelines", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/pipeline/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "pipeline", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create pipeline", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/pipeline/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "pipeline", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get pipeline", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/pipeline/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "pipeline", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update pipeline", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/pipeline/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "pipeline", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete pipeline", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/pipeline/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "pipeline", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Port", "item": [ { "name": "Close port", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/port/close/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "port", "close", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List ports", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/port/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "port", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Get port", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/port/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "port", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } } ] }, { "name": "Product", "item": [ { "name": "List products", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/product/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "product", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create product", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/product/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "product", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get product", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/product/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "product", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update product", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/product/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "product", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete product", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/product/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "product", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Project", "item": [ { "name": "List projects", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/project/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "project", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create project", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/project/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "project", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get project", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/project/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "project", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update project", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/project/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "project", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete project", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/project/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "project", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Project Task", "item": [ { "name": "List project tasks", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/project_task/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "project_task", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create project task", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/project_task/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "project_task", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get project task", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/project_task/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "project_task", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update project task", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/project_task/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "project_task", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete project task", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/project_task/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "project_task", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Quote", "item": [ { "name": "List quotes", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/quote/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "quote", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create quote", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/quote/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "quote", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get quote", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/quote/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "quote", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update quote", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/quote/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "quote", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete quote", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/quote/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "quote", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Report", "item": [ { "name": "Activity report", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/report/activity/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "report", "activity", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "GET /report/activity/ — the metrics catalog." } }, { "name": "Activity report", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/report/activity/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "report", "activity", "" ] }, "description": "POST /report/activity/ — per-user activity metrics for a period.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Funnel report", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/report/funnel/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "report", "funnel", "" ] }, "description": "POST /report/funnel/ — pipeline totals by status (+ won in period).", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Calls funnel report", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/report/calls_funnel/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "report", "calls_funnel", "" ] }, "description": "POST /report/calls_funnel/ — call volume, outcomes, and connect funnel.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Opportunity funnels report", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/report/opportunity_funnels/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "report", "opportunity_funnels", "" ] }, "description": "POST /report/opportunity_funnels/ — stage funnel per pipeline.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Sales report", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/report/sales/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "report", "sales", "" ] }, "description": "POST /report/sales/ — won revenue by month, stage conversion,\nforecast by expected close month, per-rep leaderboard, and workflow\nperformance, in one payload (feeds the dashboard and reports page).", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Lead report", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/report/status_change/lead/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "report", "status_change", "lead", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Opportunity report", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/report/status_change/opportunity/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "report", "status_change", "opportunity", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Sent emails report", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/report/sent_emails/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "report", "sent_emails", "" ] }, "description": "POST /report/sent_emails/ — per-template performance.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Role", "item": [ { "name": "List roles", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/role/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "role", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create role", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/role/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "role", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update role", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/role/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "role", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete role", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/role/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "role", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Saved Search", "item": [ { "name": "List saved searches", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/saved_search/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "saved_search", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create saved search", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/saved_search/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "saved_search", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Hot leads\",\n \"type\": \"lead\",\n \"is_shared\": true,\n \"s_query\": {\n \"query\": {\n \"type\": \"object_type\",\n \"object_type\": \"lead\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Example", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/saved_search/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "saved_search", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Hot leads\",\n \"type\": \"lead\",\n \"is_shared\": true,\n \"s_query\": {\n \"query\": {\n \"type\": \"object_type\",\n \"object_type\": \"lead\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"view_8h9i0j1k2l3m4n5o6p7q8r\",\n \"name\": \"Hot leads\",\n \"type\": \"lead\",\n \"is_shared\": true,\n \"s_query\": {\n \"query\": {\n \"type\": \"object_type\",\n \"object_type\": \"lead\"\n }\n },\n \"date_created\": \"2026-01-15T09:34:00.000Z\"\n}" } ] }, { "name": "Get saved search", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/saved_search/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "saved_search", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update saved search", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/saved_search/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "saved_search", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete saved search", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/saved_search/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "saved_search", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Scheduling Link", "item": [ { "name": "List scheduling links", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/scheduling_link/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "scheduling_link", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create scheduling link", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/scheduling_link/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "scheduling_link", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get scheduling link", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/scheduling_link/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "scheduling_link", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update scheduling link", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/scheduling_link/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "scheduling_link", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete scheduling link", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/scheduling_link/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "scheduling_link", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Send As", "item": [ { "name": "List send ases", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/send_as/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "send_as", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create send as", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/send_as/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "send_as", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete send as", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/send_as/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "send_as", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Sequence", "item": [ { "name": "List sequences", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/sequence/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sequence", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create sequence", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/sequence/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sequence", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get sequence", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/sequence/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sequence", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update sequence", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/sequence/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sequence", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete sequence", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/sequence/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sequence", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Sequence Subscription", "item": [ { "name": "List sequence subscriptions", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/sequence_subscription/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sequence_subscription", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create sequence subscription", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/sequence_subscription/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sequence_subscription", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get sequence subscription", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/sequence_subscription/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sequence_subscription", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update sequence subscription", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/sequence_subscription/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sequence_subscription", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "PUT: pause/resume.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete sequence subscription", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/sequence_subscription/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sequence_subscription", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "SMS Template", "item": [ { "name": "List sms templates", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/sms_template/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sms_template", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create sms template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/sms_template/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sms_template", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get sms template", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/sms_template/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sms_template", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update sms template", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/sms_template/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sms_template", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete sms template", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/sms_template/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sms_template", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Status", "item": [ { "name": "Lead status", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/status/lead/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "status", "lead", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Lead status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/status/lead/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "status", "lead", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get status", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/status/lead/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "status", "lead", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update status", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/status/lead/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "status", "lead", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete status", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/status/lead/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "status", "lead", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } }, { "name": "Opportunity status", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/status/opportunity/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "status", "opportunity", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Opportunity status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/status/opportunity/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "status", "opportunity", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get status", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/status/opportunity/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "status", "opportunity", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update status", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/status/opportunity/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "status", "opportunity", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete status", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/status/opportunity/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "status", "opportunity", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "Task", "item": [ { "name": "List tasks", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/task/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "task", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "response": [ { "name": "200 Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/task/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "task", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"task_4d5e6f7g8h9i0j1k2l3m4n\",\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"_type\": \"call\",\n \"text\": \"Follow up on the proposal\",\n \"date\": \"2026-02-01\",\n \"is_complete\": false,\n \"assigned_to\": \"user_0a1b2c3d4e5f6g7h8i9j0k\",\n \"date_created\": \"2026-01-15T09:33:00.000Z\"\n }\n ],\n \"has_more\": false\n}" } ] }, { "name": "Create task", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/task/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "task", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"_type\": \"call\",\n \"text\": \"Follow up on the proposal\",\n \"date\": \"2026-02-01\",\n \"assigned_to\": \"user_0a1b2c3d4e5f6g7h8i9j0k\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Example", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/task/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "task", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"_type\": \"call\",\n \"text\": \"Follow up on the proposal\",\n \"date\": \"2026-02-01\",\n \"assigned_to\": \"user_0a1b2c3d4e5f6g7h8i9j0k\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"task_4d5e6f7g8h9i0j1k2l3m4n\",\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"_type\": \"call\",\n \"text\": \"Follow up on the proposal\",\n \"date\": \"2026-02-01\",\n \"is_complete\": false,\n \"assigned_to\": \"user_0a1b2c3d4e5f6g7h8i9j0k\",\n \"date_created\": \"2026-01-15T09:33:00.000Z\"\n}" } ] }, { "name": "Put task", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/task/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "task", "" ] }, "description": "PUT /task/ — bulk update by id__in (by convention), e.g. marking a\nset of tasks complete.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get task", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/task/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "task", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "response": [ { "name": "200 Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/task/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "task", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"task_4d5e6f7g8h9i0j1k2l3m4n\",\n \"lead_id\": \"lead_2x9Qb1c3d4e5f6g7h8i9j0\",\n \"_type\": \"call\",\n \"text\": \"Follow up on the proposal\",\n \"date\": \"2026-02-01\",\n \"is_complete\": false,\n \"assigned_to\": \"user_0a1b2c3d4e5f6g7h8i9j0k\",\n \"date_created\": \"2026-01-15T09:33:00.000Z\"\n}" } ] }, { "name": "Update task", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/task/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "task", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete task", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/task/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "task", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] }, { "name": "User", "item": [ { "name": "List users", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/user/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "user", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Availability user", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/user/availability/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "user", "availability", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "GET /user/availability/ — dialer presence of all members." } }, { "name": "Availability user", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/user/availability/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "user", "availability", "" ] }, "description": "PUT /user/availability/ {availability: online|offline} — own status.", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get user", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/user/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "user", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } } ] }, { "name": "Webhook", "item": [ { "name": "List webhooks", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/webhook/?_limit=100&_skip=0&_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhook", "" ], "query": [ { "key": "_limit", "value": "100", "disabled": true, "description": "Page size (max 200)." }, { "key": "_skip", "value": "0", "disabled": true, "description": "Offset for pagination." }, { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Create webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/webhook/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhook", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://hooks.example/geniziz\",\n \"events\": [\n \"lead.created\",\n \"lead.updated\",\n \"opportunity.status_updated\"\n ],\n \"status\": \"active\",\n \"verify_ssl\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Example", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/webhook/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhook", "" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://hooks.example/geniziz\",\n \"events\": [\n \"lead.created\",\n \"lead.updated\",\n \"opportunity.status_updated\"\n ],\n \"status\": \"active\",\n \"verify_ssl\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"whk_9i0j1k2l3m4n5o6p7q8r9s\",\n \"url\": \"https://hooks.example/geniziz\",\n \"events\": [\n \"lead.created\",\n \"lead.updated\",\n \"opportunity.status_updated\"\n ],\n \"status\": \"active\",\n \"verify_ssl\": true,\n \"date_created\": \"2026-01-15T09:35:00.000Z\"\n}" } ] }, { "name": "Get webhook", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/webhook/:id/?_fields=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhook", ":id", "" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "_fields", "value": "", "disabled": true, "description": "Comma-separated fields to return." } ] }, "description": "" } }, { "name": "Update webhook", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/webhook/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhook", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete webhook", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/webhook/:id/", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhook", ":id", "" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "" } } ] } ] }