{ "info": { "_postman_id": "c1e050fe-bfb8-4ffe-83e2-872886c9837d", "name": "Pipedrive API v1 Activities Deals API", "description": "Activities are appointments/tasks/events on a calendar that can be associated with a deal, a lead, a person and an organization. Activities can be of different type (such as call, meeting, lunch or a custom type - see ActivityTypes object) and can be assigned to a particular user. Note that activities can also be created without a specific date/time.\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:37:19.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "lastUpdatedBy": "35240", "uid": "35240-c1e050fe-bfb8-4ffe-83e2-872886c9837d" }, "item": [ { "name": "deals", "item": [ { "name": "archived", "item": [ { "name": "Get all archived deals", "id": "fa633d06-39e3-43a4-9d51-044086e1856d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/archived?user_id=&filter_id=&person_id=&org_id=&product_id=&pipeline_id=&stage_id=&status=all_not_deleted&start=0&limit=&sort=&owned_by_you=1", "host": [ "{{baseUrl}}" ], "path": [ "deals", "archived" ], "query": [ { "description": "If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.", "key": "user_id", "value": "" }, { "description": "The ID of the filter to use", "key": "filter_id", "value": "" }, { "description": "If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.", "key": "person_id", "value": "" }, { "description": "If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.", "key": "org_id", "value": "" }, { "description": "If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.", "key": "product_id", "value": "" }, { "description": "If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.", "key": "pipeline_id", "value": "" }, { "description": "If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.", "key": "stage_id", "value": "" }, { "description": "Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.", "key": "status", "value": "all_not_deleted" }, { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page", "key": "limit", "value": "" }, { "description": "The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).", "key": "sort", "value": "" }, { "description": "When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.", "key": "owned_by_you", "value": "1" } ] }, "description": "Returns all archived deals." }, "response": [ { "id": "6250c374-e94d-4e1d-98c4-5d53e670c446", "name": "Get all archived deals", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/archived?user_id=&filter_id=&person_id=&org_id=&product_id=&pipeline_id=&stage_id=&status=all_not_deleted&start=0&limit=&sort=&owned_by_you=1", "host": [ "{{baseUrl}}" ], "path": [ "deals", "archived" ], "query": [ { "description": "If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.", "key": "user_id", "value": "" }, { "description": "The ID of the filter to use", "key": "filter_id", "value": "" }, { "description": "If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.", "key": "person_id", "value": "" }, { "description": "If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.", "key": "org_id", "value": "" }, { "description": "If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.", "key": "product_id", "value": "" }, { "description": "If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.", "key": "pipeline_id", "value": "" }, { "description": "If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.", "key": "stage_id", "value": "" }, { "description": "Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.", "key": "status", "value": "all_not_deleted" }, { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page", "key": "limit", "value": "" }, { "description": "The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).", "key": "sort", "value": "" }, { "description": "When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.", "key": "owned_by_you", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"creator_user_id\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"has_pic\": \"\",\n \"pic_hash\": \"\",\n \"active_flag\": \"\",\n \"value\": \"\"\n },\n \"user_id\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"has_pic\": \"\",\n \"pic_hash\": \"\",\n \"active_flag\": \"\",\n \"value\": \"\"\n },\n \"person_id\": {\n \"active_flag\": \"\",\n \"name\": \"\",\n \"email\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"phone\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"owner_id\": \"\",\n \"value\": \"\"\n },\n \"org_id\": {\n \"name\": \"\",\n \"people_count\": \"\",\n \"owner_id\": \"\",\n \"address\": \"\",\n \"active_flag\": \"\",\n \"cc_email\": \"\",\n \"value\": \"\"\n },\n \"stage_id\": \"\",\n \"title\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"active\": \"\",\n \"deleted\": \"\",\n \"is_archived\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"next_activity_date\": \"\",\n \"next_activity_time\": \"\",\n \"next_activity_id\": \"\",\n \"last_activity_id\": \"\",\n \"last_activity_date\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"pipeline_id\": \"\",\n \"won_time\": \"\",\n \"first_won_time\": \"\",\n \"lost_time\": \"\",\n \"products_count\": \"\",\n \"files_count\": \"\",\n \"notes_count\": \"\",\n \"followers_count\": \"\",\n \"email_messages_count\": \"\",\n \"activities_count\": \"\",\n \"done_activities_count\": \"\",\n \"undone_activities_count\": \"\",\n \"participants_count\": \"\",\n \"expected_close_date\": \"\",\n \"last_incoming_mail_time\": \"\",\n \"last_outgoing_mail_time\": \"\",\n \"label\": \"\",\n \"stage_order_nr\": \"\",\n \"person_name\": \"\",\n \"org_name\": \"\",\n \"next_activity_subject\": \"\",\n \"next_activity_type\": \"\",\n \"next_activity_duration\": \"\",\n \"next_activity_note\": \"\",\n \"formatted_value\": \"\",\n \"weighted_value\": \"\",\n \"formatted_weighted_value\": \"\",\n \"weighted_value_currency\": \"\",\n \"rotten_time\": \"\",\n \"owner_name\": \"\",\n \"cc_email\": \"\",\n \"org_hidden\": \"\",\n \"person_hidden\": \"\",\n \"origin\": \"\",\n \"origin_id\": \"\",\n \"channel\": \"\",\n \"channel_id\": \"\",\n \"arr\": \"\",\n \"mrr\": \"\",\n \"acv\": \"\",\n \"arr_currency\": \"\",\n \"mrr_currency\": \"\",\n \"acv_currency\": \"\"\n },\n {\n \"id\": \"\",\n \"creator_user_id\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"has_pic\": \"\",\n \"pic_hash\": \"\",\n \"active_flag\": \"\",\n \"value\": \"\"\n },\n \"user_id\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"has_pic\": \"\",\n \"pic_hash\": \"\",\n \"active_flag\": \"\",\n \"value\": \"\"\n },\n \"person_id\": {\n \"active_flag\": \"\",\n \"name\": \"\",\n \"email\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"phone\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"owner_id\": \"\",\n \"value\": \"\"\n },\n \"org_id\": {\n \"name\": \"\",\n \"people_count\": \"\",\n \"owner_id\": \"\",\n \"address\": \"\",\n \"active_flag\": \"\",\n \"cc_email\": \"\",\n \"value\": \"\"\n },\n \"stage_id\": \"\",\n \"title\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"active\": \"\",\n \"deleted\": \"\",\n \"is_archived\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"next_activity_date\": \"\",\n \"next_activity_time\": \"\",\n \"next_activity_id\": \"\",\n \"last_activity_id\": \"\",\n \"last_activity_date\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"pipeline_id\": \"\",\n \"won_time\": \"\",\n \"first_won_time\": \"\",\n \"lost_time\": \"\",\n \"products_count\": \"\",\n \"files_count\": \"\",\n \"notes_count\": \"\",\n \"followers_count\": \"\",\n \"email_messages_count\": \"\",\n \"activities_count\": \"\",\n \"done_activities_count\": \"\",\n \"undone_activities_count\": \"\",\n \"participants_count\": \"\",\n \"expected_close_date\": \"\",\n \"last_incoming_mail_time\": \"\",\n \"last_outgoing_mail_time\": \"\",\n \"label\": \"\",\n \"stage_order_nr\": \"\",\n \"person_name\": \"\",\n \"org_name\": \"\",\n \"next_activity_subject\": \"\",\n \"next_activity_type\": \"\",\n \"next_activity_duration\": \"\",\n \"next_activity_note\": \"\",\n \"formatted_value\": \"\",\n \"weighted_value\": \"\",\n \"formatted_weighted_value\": \"\",\n \"weighted_value_currency\": \"\",\n \"rotten_time\": \"\",\n \"owner_name\": \"\",\n \"cc_email\": \"\",\n \"org_hidden\": \"\",\n \"person_hidden\": \"\",\n \"origin\": \"\",\n \"origin_id\": \"\",\n \"channel\": \"\",\n \"channel_id\": \"\",\n \"arr\": \"\",\n \"mrr\": \"\",\n \"acv\": \"\",\n \"arr_currency\": \"\",\n \"mrr_currency\": \"\",\n \"acv_currency\": \"\"\n }\n ],\n \"additional_data\": {\n \"start\": \"\",\n \"limit\": \"\",\n \"more_items_in_collection\": \"\"\n },\n \"related_objects\": {\n \"user\": {\n \"USER_ID\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"has_pic\": \"\",\n \"pic_hash\": \"\",\n \"active_flag\": \"\"\n }\n },\n \"organization\": {\n \"ORGANIZATION_ID\": {\n \"active_flag\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"people_count\": \"\",\n \"owner_id\": \"\",\n \"address\": \"\",\n \"cc_email\": \"\"\n }\n },\n \"person\": {\n \"PERSON_ID\": {\n \"active_flag\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"phone\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"owner_id\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-6250c374-e94d-4e1d-98c4-5d53e670c446" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-fa633d06-39e3-43a4-9d51-044086e1856d" } ], "id": "2cb23da0-39c4-4653-b677-54dfbed9640b", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-2cb23da0-39c4-4653-b677-54dfbed9640b" }, { "name": "summary", "item": [ { "name": "archived", "item": [ { "name": "Get archived deals summary", "id": "c7e2bca3-904d-47bf-9d6f-9613bae6b1f0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/summary/archived?status=lost&filter_id=&user_id=&pipeline_id=&stage_id=", "host": [ "{{baseUrl}}" ], "path": [ "deals", "summary", "archived" ], "query": [ { "description": "Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.", "key": "status", "value": "lost" }, { "description": "user_id will not be considered. Only deals matching the given filter will be returned.", "key": "filter_id", "value": "" }, { "description": "Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.", "key": "user_id", "value": "" }, { "description": "Only deals within the given pipeline will be returned", "key": "pipeline_id", "value": "" }, { "description": "Only deals within the given stage will be returned", "key": "stage_id", "value": "" } ] }, "description": "Returns a summary of all archived deals." }, "response": [ { "id": "2acaa04f-f1b2-4803-b520-3b6f438892da", "name": "Get the summary of archived deals", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/summary/archived?status=lost&filter_id=&user_id=&pipeline_id=&stage_id=", "host": [ "{{baseUrl}}" ], "path": [ "deals", "summary", "archived" ], "query": [ { "description": "Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.", "key": "status", "value": "lost" }, { "description": "user_id will not be considered. Only deals matching the given filter will be returned.", "key": "filter_id", "value": "" }, { "description": "Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.", "key": "user_id", "value": "" }, { "description": "Only deals within the given pipeline will be returned", "key": "pipeline_id", "value": "" }, { "description": "Only deals within the given stage will be returned", "key": "stage_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"values_total\": {\n \"value\": \"\",\n \"count\": \"\",\n \"value_converted\": \"\",\n \"value_formatted\": \"\",\n \"value_converted_formatted\": \"\"\n },\n \"weighted_values_total\": {\n \"value\": \"\",\n \"count\": \"\",\n \"value_formatted\": \"\"\n },\n \"total_count\": \"\",\n \"total_currency_converted_value\": \"\",\n \"total_weighted_currency_converted_value\": \"\",\n \"total_currency_converted_value_formatted\": \"\",\n \"total_weighted_currency_converted_value_formatted\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-2acaa04f-f1b2-4803-b520-3b6f438892da" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-c7e2bca3-904d-47bf-9d6f-9613bae6b1f0" } ], "id": "a20df795-a393-4f9d-93cb-ef2be8961072", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-a20df795-a393-4f9d-93cb-ef2be8961072" }, { "name": "Get deals summary", "id": "63c195bb-9117-40b1-ab14-cb346e2ea5d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/summary?status=lost&filter_id=&user_id=&pipeline_id=&stage_id=", "host": [ "{{baseUrl}}" ], "path": [ "deals", "summary" ], "query": [ { "description": "Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.", "key": "status", "value": "lost" }, { "description": "user_id will not be considered. Only deals matching the given filter will be returned.", "key": "filter_id", "value": "" }, { "description": "Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.", "key": "user_id", "value": "" }, { "description": "Only deals within the given pipeline will be returned", "key": "pipeline_id", "value": "" }, { "description": "Only deals within the given stage will be returned", "key": "stage_id", "value": "" } ] }, "description": "Returns a summary of all not archived deals." }, "response": [ { "id": "aff52a26-4ba2-42fa-833f-3750c6423cad", "name": "Get the summary of not archived deals", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/summary?status=lost&filter_id=&user_id=&pipeline_id=&stage_id=", "host": [ "{{baseUrl}}" ], "path": [ "deals", "summary" ], "query": [ { "description": "Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.", "key": "status", "value": "lost" }, { "description": "user_id will not be considered. Only deals matching the given filter will be returned.", "key": "filter_id", "value": "" }, { "description": "Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.", "key": "user_id", "value": "" }, { "description": "Only deals within the given pipeline will be returned", "key": "pipeline_id", "value": "" }, { "description": "Only deals within the given stage will be returned", "key": "stage_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"values_total\": {\n \"value\": \"\",\n \"count\": \"\",\n \"value_converted\": \"\",\n \"value_formatted\": \"\",\n \"value_converted_formatted\": \"\"\n },\n \"weighted_values_total\": {\n \"value\": \"\",\n \"count\": \"\",\n \"value_formatted\": \"\"\n },\n \"total_count\": \"\",\n \"total_currency_converted_value\": \"\",\n \"total_weighted_currency_converted_value\": \"\",\n \"total_currency_converted_value_formatted\": \"\",\n \"total_weighted_currency_converted_value_formatted\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-aff52a26-4ba2-42fa-833f-3750c6423cad" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-63c195bb-9117-40b1-ab14-cb346e2ea5d1" } ], "id": "f4678f8a-00a1-424f-80d0-116df1be37f3", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-f4678f8a-00a1-424f-80d0-116df1be37f3" }, { "name": "timeline", "item": [ { "name": "archived", "item": [ { "name": "Get archived deals timeline", "id": "3c8f024e-bdbd-49ab-a311-f282972671a1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/timeline/archived?start_date=&interval=week&amount=&field_key=&user_id=&pipeline_id=&filter_id=&exclude_deals=1&totals_convert_currency=", "host": [ "{{baseUrl}}" ], "path": [ "deals", "timeline", "archived" ], "query": [ { "description": "(Required) The date when the first interval starts. Format: YYYY-MM-DD.", "key": "start_date", "value": "" }, { "description": "(Required) The type of the interval
ValueDescription
`day`Day
`week`A full week (7 days) starting from `start_date`
`month`A full month (depending on the number of days in given month) starting from `start_date`
`quarter`A full quarter (3 months) starting from `start_date`
", "key": "interval", "value": "week" }, { "description": "(Required) The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).", "key": "amount", "value": "" }, { "description": "(Required) The date field key which deals will be retrieved from", "key": "field_key", "value": "" }, { "description": "If supplied, only deals matching the given user will be returned", "key": "user_id", "value": "" }, { "description": "If supplied, only deals matching the given pipeline will be returned", "key": "pipeline_id", "value": "" }, { "description": "If supplied, only deals matching the given filter will be returned", "key": "filter_id", "value": "" }, { "description": "Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.", "key": "exclude_deals", "value": "1" }, { "description": "The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user's default currency is used.", "key": "totals_convert_currency", "value": "" } ] }, "description": "Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) \u2014 e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups \u2014 January, February and March \u2014 based on the value of the given `field_key`." }, "response": [ { "id": "5307dd52-1d33-488c-8d4d-880eeb4c1a25", "name": "Get open and won deals, grouped by the defined interval of time", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/timeline/archived?start_date=&interval=week&amount=&field_key=&user_id=&pipeline_id=&filter_id=&exclude_deals=1&totals_convert_currency=", "host": [ "{{baseUrl}}" ], "path": [ "deals", "timeline", "archived" ], "query": [ { "description": "(Required) The date when the first interval starts. Format: YYYY-MM-DD.", "key": "start_date", "value": "" }, { "description": "(Required) The type of the interval
ValueDescription
`day`Day
`week`A full week (7 days) starting from `start_date`
`month`A full month (depending on the number of days in given month) starting from `start_date`
`quarter`A full quarter (3 months) starting from `start_date`
", "key": "interval", "value": "week" }, { "description": "(Required) The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).", "key": "amount", "value": "" }, { "description": "(Required) The date field key which deals will be retrieved from", "key": "field_key", "value": "" }, { "description": "If supplied, only deals matching the given user will be returned", "key": "user_id", "value": "" }, { "description": "If supplied, only deals matching the given pipeline will be returned", "key": "pipeline_id", "value": "" }, { "description": "If supplied, only deals matching the given filter will be returned", "key": "filter_id", "value": "" }, { "description": "Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.", "key": "exclude_deals", "value": "1" }, { "description": "The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user's default currency is used.", "key": "totals_convert_currency", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"period_start\": \"\",\n \"period_end\": \"\",\n \"deals\": [\n {\n \"id\": \"\",\n \"creator_user_id\": \"\",\n \"user_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"stage_id\": \"\",\n \"title\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"active\": \"\",\n \"deleted\": \"\",\n \"is_archived\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"next_activity_date\": \"\",\n \"next_activity_time\": \"\",\n \"next_activity_id\": \"\",\n \"last_activity_id\": \"\",\n \"last_activity_date\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"pipeline_id\": \"\",\n \"won_time\": \"\",\n \"first_won_time\": \"\",\n \"lost_time\": \"\",\n \"products_count\": \"\",\n \"files_count\": \"\",\n \"notes_count\": \"\",\n \"followers_count\": \"\",\n \"email_messages_count\": \"\",\n \"activities_count\": \"\",\n \"done_activities_count\": \"\",\n \"undone_activities_count\": \"\",\n \"participants_count\": \"\",\n \"expected_close_date\": \"\",\n \"last_incoming_mail_time\": \"\",\n \"last_outgoing_mail_time\": \"\",\n \"label\": \"\",\n \"stage_order_nr\": \"\",\n \"person_name\": \"\",\n \"org_name\": \"\",\n \"next_activity_subject\": \"\",\n \"next_activity_type\": \"\",\n \"next_activity_duration\": \"\",\n \"next_activity_note\": \"\",\n \"formatted_value\": \"\",\n \"weighted_value\": \"\",\n \"formatted_weighted_value\": \"\",\n \"weighted_value_currency\": \"\",\n \"rotten_time\": \"\",\n \"owner_name\": \"\",\n \"cc_email\": \"\",\n \"org_hidden\": \"\",\n \"person_hidden\": \"\",\n \"origin\": \"\",\n \"origin_id\": \"\",\n \"channel\": \"\",\n \"channel_id\": \"\",\n \"arr\": \"\",\n \"mrr\": \"\",\n \"acv\": \"\",\n \"arr_currency\": \"\",\n \"mrr_currency\": \"\",\n \"acv_currency\": \"\"\n },\n {\n \"id\": \"\",\n \"creator_user_id\": \"\",\n \"user_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"stage_id\": \"\",\n \"title\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"active\": \"\",\n \"deleted\": \"\",\n \"is_archived\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"next_activity_date\": \"\",\n \"next_activity_time\": \"\",\n \"next_activity_id\": \"\",\n \"last_activity_id\": \"\",\n \"last_activity_date\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"pipeline_id\": \"\",\n \"won_time\": \"\",\n \"first_won_time\": \"\",\n \"lost_time\": \"\",\n \"products_count\": \"\",\n \"files_count\": \"\",\n \"notes_count\": \"\",\n \"followers_count\": \"\",\n \"email_messages_count\": \"\",\n \"activities_count\": \"\",\n \"done_activities_count\": \"\",\n \"undone_activities_count\": \"\",\n \"participants_count\": \"\",\n \"expected_close_date\": \"\",\n \"last_incoming_mail_time\": \"\",\n \"last_outgoing_mail_time\": \"\",\n \"label\": \"\",\n \"stage_order_nr\": \"\",\n \"person_name\": \"\",\n \"org_name\": \"\",\n \"next_activity_subject\": \"\",\n \"next_activity_type\": \"\",\n \"next_activity_duration\": \"\",\n \"next_activity_note\": \"\",\n \"formatted_value\": \"\",\n \"weighted_value\": \"\",\n \"formatted_weighted_value\": \"\",\n \"weighted_value_currency\": \"\",\n \"rotten_time\": \"\",\n \"owner_name\": \"\",\n \"cc_email\": \"\",\n \"org_hidden\": \"\",\n \"person_hidden\": \"\",\n \"origin\": \"\",\n \"origin_id\": \"\",\n \"channel\": \"\",\n \"channel_id\": \"\",\n \"arr\": \"\",\n \"mrr\": \"\",\n \"acv\": \"\",\n \"arr_currency\": \"\",\n \"mrr_currency\": \"\",\n \"acv_currency\": \"\"\n }\n ],\n \"totals\": {\n \"count\": \"\",\n \"values\": {},\n \"weighted_values\": {},\n \"open_count\": \"\",\n \"open_values\": {},\n \"weighted_open_values\": {},\n \"won_count\": \"\",\n \"won_values\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-5307dd52-1d33-488c-8d4d-880eeb4c1a25" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-3c8f024e-bdbd-49ab-a311-f282972671a1" } ], "id": "d771ac4a-fef0-4a72-bff9-4df8888b9dfc", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-d771ac4a-fef0-4a72-bff9-4df8888b9dfc" }, { "name": "Get deals timeline", "id": "586eb02a-3afe-4c5b-b2b7-1e77ea115158", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/timeline?start_date=&interval=week&amount=&field_key=&user_id=&pipeline_id=&filter_id=&exclude_deals=1&totals_convert_currency=", "host": [ "{{baseUrl}}" ], "path": [ "deals", "timeline" ], "query": [ { "description": "(Required) The date when the first interval starts. Format: YYYY-MM-DD.", "key": "start_date", "value": "" }, { "description": "(Required) The type of the interval
ValueDescription
`day`Day
`week`A full week (7 days) starting from `start_date`
`month`A full month (depending on the number of days in given month) starting from `start_date`
`quarter`A full quarter (3 months) starting from `start_date`
", "key": "interval", "value": "week" }, { "description": "(Required) The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).", "key": "amount", "value": "" }, { "description": "(Required) The date field key which deals will be retrieved from", "key": "field_key", "value": "" }, { "description": "If supplied, only deals matching the given user will be returned", "key": "user_id", "value": "" }, { "description": "If supplied, only deals matching the given pipeline will be returned", "key": "pipeline_id", "value": "" }, { "description": "If supplied, only deals matching the given filter will be returned", "key": "filter_id", "value": "" }, { "description": "Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.", "key": "exclude_deals", "value": "1" }, { "description": "The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user's default currency is used.", "key": "totals_convert_currency", "value": "" } ] }, "description": "Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) \u2014 e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups \u2014 January, February and March \u2014 based on the value of the given `field_key`." }, "response": [ { "id": "25853c8c-4a8a-40ad-929c-b142b7949221", "name": "Get open and won deals, grouped by the defined interval of time", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/timeline?start_date=&interval=week&amount=&field_key=&user_id=&pipeline_id=&filter_id=&exclude_deals=1&totals_convert_currency=", "host": [ "{{baseUrl}}" ], "path": [ "deals", "timeline" ], "query": [ { "description": "(Required) The date when the first interval starts. Format: YYYY-MM-DD.", "key": "start_date", "value": "" }, { "description": "(Required) The type of the interval
ValueDescription
`day`Day
`week`A full week (7 days) starting from `start_date`
`month`A full month (depending on the number of days in given month) starting from `start_date`
`quarter`A full quarter (3 months) starting from `start_date`
", "key": "interval", "value": "week" }, { "description": "(Required) The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).", "key": "amount", "value": "" }, { "description": "(Required) The date field key which deals will be retrieved from", "key": "field_key", "value": "" }, { "description": "If supplied, only deals matching the given user will be returned", "key": "user_id", "value": "" }, { "description": "If supplied, only deals matching the given pipeline will be returned", "key": "pipeline_id", "value": "" }, { "description": "If supplied, only deals matching the given filter will be returned", "key": "filter_id", "value": "" }, { "description": "Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.", "key": "exclude_deals", "value": "1" }, { "description": "The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user's default currency is used.", "key": "totals_convert_currency", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"period_start\": \"\",\n \"period_end\": \"\",\n \"deals\": [\n {\n \"id\": \"\",\n \"creator_user_id\": \"\",\n \"user_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"stage_id\": \"\",\n \"title\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"active\": \"\",\n \"deleted\": \"\",\n \"is_archived\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"next_activity_date\": \"\",\n \"next_activity_time\": \"\",\n \"next_activity_id\": \"\",\n \"last_activity_id\": \"\",\n \"last_activity_date\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"pipeline_id\": \"\",\n \"won_time\": \"\",\n \"first_won_time\": \"\",\n \"lost_time\": \"\",\n \"products_count\": \"\",\n \"files_count\": \"\",\n \"notes_count\": \"\",\n \"followers_count\": \"\",\n \"email_messages_count\": \"\",\n \"activities_count\": \"\",\n \"done_activities_count\": \"\",\n \"undone_activities_count\": \"\",\n \"participants_count\": \"\",\n \"expected_close_date\": \"\",\n \"last_incoming_mail_time\": \"\",\n \"last_outgoing_mail_time\": \"\",\n \"label\": \"\",\n \"stage_order_nr\": \"\",\n \"person_name\": \"\",\n \"org_name\": \"\",\n \"next_activity_subject\": \"\",\n \"next_activity_type\": \"\",\n \"next_activity_duration\": \"\",\n \"next_activity_note\": \"\",\n \"formatted_value\": \"\",\n \"weighted_value\": \"\",\n \"formatted_weighted_value\": \"\",\n \"weighted_value_currency\": \"\",\n \"rotten_time\": \"\",\n \"owner_name\": \"\",\n \"cc_email\": \"\",\n \"org_hidden\": \"\",\n \"person_hidden\": \"\",\n \"origin\": \"\",\n \"origin_id\": \"\",\n \"channel\": \"\",\n \"channel_id\": \"\",\n \"arr\": \"\",\n \"mrr\": \"\",\n \"acv\": \"\",\n \"arr_currency\": \"\",\n \"mrr_currency\": \"\",\n \"acv_currency\": \"\"\n },\n {\n \"id\": \"\",\n \"creator_user_id\": \"\",\n \"user_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"stage_id\": \"\",\n \"title\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"active\": \"\",\n \"deleted\": \"\",\n \"is_archived\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"next_activity_date\": \"\",\n \"next_activity_time\": \"\",\n \"next_activity_id\": \"\",\n \"last_activity_id\": \"\",\n \"last_activity_date\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"pipeline_id\": \"\",\n \"won_time\": \"\",\n \"first_won_time\": \"\",\n \"lost_time\": \"\",\n \"products_count\": \"\",\n \"files_count\": \"\",\n \"notes_count\": \"\",\n \"followers_count\": \"\",\n \"email_messages_count\": \"\",\n \"activities_count\": \"\",\n \"done_activities_count\": \"\",\n \"undone_activities_count\": \"\",\n \"participants_count\": \"\",\n \"expected_close_date\": \"\",\n \"last_incoming_mail_time\": \"\",\n \"last_outgoing_mail_time\": \"\",\n \"label\": \"\",\n \"stage_order_nr\": \"\",\n \"person_name\": \"\",\n \"org_name\": \"\",\n \"next_activity_subject\": \"\",\n \"next_activity_type\": \"\",\n \"next_activity_duration\": \"\",\n \"next_activity_note\": \"\",\n \"formatted_value\": \"\",\n \"weighted_value\": \"\",\n \"formatted_weighted_value\": \"\",\n \"weighted_value_currency\": \"\",\n \"rotten_time\": \"\",\n \"owner_name\": \"\",\n \"cc_email\": \"\",\n \"org_hidden\": \"\",\n \"person_hidden\": \"\",\n \"origin\": \"\",\n \"origin_id\": \"\",\n \"channel\": \"\",\n \"channel_id\": \"\",\n \"arr\": \"\",\n \"mrr\": \"\",\n \"acv\": \"\",\n \"arr_currency\": \"\",\n \"mrr_currency\": \"\",\n \"acv_currency\": \"\"\n }\n ],\n \"totals\": {\n \"count\": \"\",\n \"values\": {},\n \"weighted_values\": {},\n \"open_count\": \"\",\n \"open_values\": {},\n \"weighted_open_values\": {},\n \"won_count\": \"\",\n \"won_values\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-25853c8c-4a8a-40ad-929c-b142b7949221" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-586eb02a-3afe-4c5b-b2b7-1e77ea115158" } ], "id": "dd96aa76-e91a-4f2f-ad15-53577b5c4850", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-dd96aa76-e91a-4f2f-ad15-53577b5c4850" }, { "name": "{id}", "item": [ { "name": "changelog", "item": [ { "name": "List updates about deal field values", "id": "235d2648-8fba-479c-9c4f-0943ca51277e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/changelog?cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "changelog" ], "query": [ { "description": "For pagination, the marker (an opaque string value) representing the first item on the next page", "key": "cursor", "value": "" }, { "description": "Items shown per page", "key": "limit", "value": "" } ], "variable": [ { "id": "c98e07e4-7a0b-4a86-82ee-7d45ee37824b", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Lists updates about field values of a deal." }, "response": [ { "id": "42863dd4-9b84-4af6-ac07-0c1d14d070e4", "name": "Get changelog of a deal", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/changelog?cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "changelog" ], "query": [ { "description": "For pagination, the marker (an opaque string value) representing the first item on the next page", "key": "cursor", "value": "" }, { "description": "Items shown per page", "key": "limit", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"field_key\": \"\",\n \"old_value\": \"\",\n \"new_value\": \"\",\n \"actor_user_id\": \"\",\n \"time\": \"\",\n \"change_source\": \"\",\n \"change_source_user_agent\": \"\",\n \"is_bulk_update_flag\": \"\"\n },\n {\n \"field_key\": \"\",\n \"old_value\": \"\",\n \"new_value\": \"\",\n \"actor_user_id\": \"\",\n \"time\": \"\",\n \"change_source\": \"\",\n \"change_source_user_agent\": \"\",\n \"is_bulk_update_flag\": \"\"\n }\n ],\n \"additional_data\": {\n \"next_cursor\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-42863dd4-9b84-4af6-ac07-0c1d14d070e4" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-235d2648-8fba-479c-9c4f-0943ca51277e" } ], "id": "557e47fa-2fb5-485c-9fdb-dba8f2ceab3c", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-557e47fa-2fb5-485c-9fdb-dba8f2ceab3c" }, { "name": "duplicate", "item": [ { "name": "Duplicate deal", "id": "68d99670-3d9e-4a2d-bcda-ca4c42444dd6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "duplicate" ], "variable": [ { "id": "e0c2b2c6-88b9-47c5-b6f7-4b8bab71dce8", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Duplicates a deal." }, "response": [ { "id": "cf09b159-db6f-4b69-9a1f-b7895b9fe169", "name": "Duplicate a deal", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "duplicate" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"creator_user_id\": \"\",\n \"user_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"stage_id\": \"\",\n \"title\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"active\": \"\",\n \"deleted\": \"\",\n \"is_archived\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"next_activity_date\": \"\",\n \"next_activity_time\": \"\",\n \"next_activity_id\": \"\",\n \"last_activity_id\": \"\",\n \"last_activity_date\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"pipeline_id\": \"\",\n \"won_time\": \"\",\n \"first_won_time\": \"\",\n \"lost_time\": \"\",\n \"products_count\": \"\",\n \"files_count\": \"\",\n \"notes_count\": \"\",\n \"followers_count\": \"\",\n \"email_messages_count\": \"\",\n \"activities_count\": \"\",\n \"done_activities_count\": \"\",\n \"undone_activities_count\": \"\",\n \"participants_count\": \"\",\n \"expected_close_date\": \"\",\n \"last_incoming_mail_time\": \"\",\n \"last_outgoing_mail_time\": \"\",\n \"label\": \"\",\n \"stage_order_nr\": \"\",\n \"person_name\": \"\",\n \"org_name\": \"\",\n \"next_activity_subject\": \"\",\n \"next_activity_type\": \"\",\n \"next_activity_duration\": \"\",\n \"next_activity_note\": \"\",\n \"formatted_value\": \"\",\n \"weighted_value\": \"\",\n \"formatted_weighted_value\": \"\",\n \"weighted_value_currency\": \"\",\n \"rotten_time\": \"\",\n \"owner_name\": \"\",\n \"cc_email\": \"\",\n \"org_hidden\": \"\",\n \"person_hidden\": \"\",\n \"origin\": \"\",\n \"origin_id\": \"\",\n \"channel\": \"\",\n \"channel_id\": \"\",\n \"arr\": \"\",\n \"mrr\": \"\",\n \"acv\": \"\",\n \"arr_currency\": \"\",\n \"mrr_currency\": \"\",\n \"acv_currency\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-cf09b159-db6f-4b69-9a1f-b7895b9fe169" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-68d99670-3d9e-4a2d-bcda-ca4c42444dd6" } ], "id": "a2b1afa6-4ad2-419f-ad8f-9ac673a56ed2", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-a2b1afa6-4ad2-419f-ad8f-9ac673a56ed2" }, { "name": "files", "item": [ { "name": "List files attached to a deal", "id": "3d9b629b-d545-4d8f-b10f-cb980ea98419", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/files?start=0&limit=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "files" ], "query": [ { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page. Please note that a maximum value of 100 is allowed.", "key": "limit", "value": "" }, { "description": "Supported fields: `id`, `update_time`", "key": "sort", "value": "" } ], "variable": [ { "id": "db6c2229-3698-4de4-8c2e-1459d1c28d91", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Lists files associated with a deal." }, "response": [ { "id": "45def753-b6a2-4da3-900d-1d060b48e0a2", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/files?start=0&limit=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "files" ], "query": [ { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page. Please note that a maximum value of 100 is allowed.", "key": "limit", "value": "" }, { "description": "Supported fields: `id`, `update_time`", "key": "sort", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"deal_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"product_id\": \"\",\n \"activity_id\": \"\",\n \"lead_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"file_name\": \"\",\n \"file_size\": \"\",\n \"active_flag\": \"\",\n \"inline_flag\": \"\",\n \"remote_location\": \"\",\n \"remote_id\": \"\",\n \"cid\": \"\",\n \"s3_bucket\": \"\",\n \"mail_message_id\": \"\",\n \"mail_template_id\": \"\",\n \"deal_name\": \"\",\n \"person_name\": \"\",\n \"org_name\": \"\",\n \"product_name\": \"\",\n \"lead_name\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"deal_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"product_id\": \"\",\n \"activity_id\": \"\",\n \"lead_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"file_name\": \"\",\n \"file_size\": \"\",\n \"active_flag\": \"\",\n \"inline_flag\": \"\",\n \"remote_location\": \"\",\n \"remote_id\": \"\",\n \"cid\": \"\",\n \"s3_bucket\": \"\",\n \"mail_message_id\": \"\",\n \"mail_template_id\": \"\",\n \"deal_name\": \"\",\n \"person_name\": \"\",\n \"org_name\": \"\",\n \"product_name\": \"\",\n \"lead_name\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n }\n ],\n \"additional_data\": {\n \"start\": \"\",\n \"limit\": \"\",\n \"more_items_in_collection\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-45def753-b6a2-4da3-900d-1d060b48e0a2" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-3d9b629b-d545-4d8f-b10f-cb980ea98419" } ], "id": "195220b0-1c07-428c-8201-1000694d3549", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-195220b0-1c07-428c-8201-1000694d3549" }, { "name": "flow", "item": [ { "name": "List updates about a deal", "id": "80997b29-0c22-42c3-ad9a-959ab7cf4a83", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/flow?start=0&limit=&all_changes=&items=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "flow" ], "query": [ { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page", "key": "limit", "value": "" }, { "description": "Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.", "key": "all_changes", "value": "" }, { "description": "A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).", "key": "items", "value": "" } ], "variable": [ { "id": "898cd85c-91d3-4aeb-9420-c1103f1b04f3", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Lists updates about a deal." }, "response": [ { "id": "aa309492-988f-4ff1-a24b-48b8679f3841", "name": "Get the deal updates", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/flow?start=0&limit=&all_changes=&items=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "flow" ], "query": [ { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page", "key": "limit", "value": "" }, { "description": "Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.", "key": "all_changes", "value": "" }, { "description": "A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).", "key": "items", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"object\": \"\",\n \"timestamp\": \"\",\n \"data\": {}\n },\n {\n \"object\": \"\",\n \"timestamp\": \"\",\n \"data\": {}\n }\n ],\n \"additional_data\": {\n \"start\": \"\",\n \"limit\": \"\",\n \"more_items_in_collection\": \"\"\n },\n \"related_objects\": {\n \"deal\": {\n \"DEAL_ID\": {\n \"id\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"stage_id\": \"\",\n \"pipeline_id\": \"\"\n }\n },\n \"organization\": {\n \"ORGANIZATION_ID\": {\n \"id\": \"\",\n \"name\": \"\",\n \"people_count\": \"\",\n \"owner_id\": \"\",\n \"address\": \"\",\n \"cc_email\": \"\"\n }\n },\n \"user\": {\n \"USER_ID\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"has_pic\": \"\",\n \"pic_hash\": \"\",\n \"active_flag\": \"\"\n }\n },\n \"person\": {\n \"PERSON_ID\": {\n \"active_flag\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"phone\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"owner_id\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-aa309492-988f-4ff1-a24b-48b8679f3841" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-80997b29-0c22-42c3-ad9a-959ab7cf4a83" } ], "id": "aaa773f3-4462-47d1-be64-1909ed91aa1a", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-aaa773f3-4462-47d1-be64-1909ed91aa1a" }, { "name": "participantsChangelog", "item": [ { "name": "List updates about participants of a deal", "id": "2d7d58fe-150c-4429-8345-8592d57cbd55", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/participantsChangelog?limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "participantsChangelog" ], "query": [ { "description": "Items shown per page", "key": "limit", "value": "" }, { "description": "For pagination, the marker (an opaque string value) representing the first item on the next page", "key": "cursor", "value": "" } ], "variable": [ { "id": "47a668b7-7e1b-41f0-8f41-3bf4c02f8892", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on pagination." }, "response": [ { "id": "e5994fe8-f96a-45cc-9b75-a301ba94b224", "name": "Get participant changelogs for a given deal", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/participantsChangelog?limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "participantsChangelog" ], "query": [ { "description": "Items shown per page", "key": "limit", "value": "" }, { "description": "For pagination, the marker (an opaque string value) representing the first item on the next page", "key": "cursor", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"actor_user_id\": \"\",\n \"person_id\": \"\",\n \"action\": \"\",\n \"time\": \"\"\n },\n {\n \"actor_user_id\": \"\",\n \"person_id\": \"\",\n \"action\": \"\",\n \"time\": \"\"\n }\n ],\n \"additional_data\": {\n \"start\": \"\",\n \"limit\": \"\",\n \"more_items_in_collection\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-e5994fe8-f96a-45cc-9b75-a301ba94b224" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-2d7d58fe-150c-4429-8345-8592d57cbd55" } ], "id": "0aeb3486-ca7f-4bae-8818-78431b527d4a", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-0aeb3486-ca7f-4bae-8818-78431b527d4a" }, { "name": "followers", "item": [ { "name": "{follower_id}", "item": [ { "name": "Delete a follower from a deal", "id": "4c6bc442-566c-48b7-b979-a08e9769d0ff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/followers/:follower_id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "followers", ":follower_id" ], "variable": [ { "id": "ca8b998f-f580-479e-957f-e7b320c3b3fc", "key": "id", "value": "", "description": "(Required) The ID of the deal" }, { "id": "81fe3264-5f1d-4b35-99d5-2ba21d4ee3a5", "key": "follower_id", "value": "", "description": "(Required) The ID of the relationship between the follower and the deal" } ] }, "description": "Deletes a follower from a deal." }, "response": [ { "id": "983bd484-52a4-485b-a3c0-3085b99be996", "name": "Delete a follower from a deal", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/followers/:follower_id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "followers", ":follower_id" ], "variable": [ { "key": "id" }, { "key": "follower_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-983bd484-52a4-485b-a3c0-3085b99be996" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-4c6bc442-566c-48b7-b979-a08e9769d0ff" } ], "id": "716cf082-ce9e-4294-8ed0-6e833dee9b26", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-716cf082-ce9e-4294-8ed0-6e833dee9b26" }, { "name": "changelog", "item": [ { "name": "List followers changelog of a deal", "id": "fa7240b1-b048-4743-8fa5-375ca8073458", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/followers/changelog?limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "followers", "changelog" ], "query": [ { "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.", "key": "limit", "value": "" }, { "description": "For pagination, the marker (an opaque string value) representing the first item on the next page", "key": "cursor", "value": "" } ], "variable": [ { "id": "f9acca7e-837c-4eea-b3c2-7ff2234f2fa6", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Lists changelogs about users have followed the deal." }, "response": [ { "id": "3e903bb0-1308-4ede-993d-3edf644f20a6", "name": "List entity followers", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/followers/changelog?limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "followers", "changelog" ], "query": [ { "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.", "key": "limit", "value": "" }, { "description": "For pagination, the marker (an opaque string value) representing the first item on the next page", "key": "cursor", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"action\": \"\",\n \"actor_user_id\": \"\",\n \"follower_user_id\": \"\",\n \"time\": \"\"\n },\n {\n \"action\": \"\",\n \"actor_user_id\": \"\",\n \"follower_user_id\": \"\",\n \"time\": \"\"\n }\n ],\n \"additional_data\": {\n \"next_cursor\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-3e903bb0-1308-4ede-993d-3edf644f20a6" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-fa7240b1-b048-4743-8fa5-375ca8073458" } ], "id": "2d989a98-1e94-4cdd-9967-54d00bfb6791", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-2d989a98-1e94-4cdd-9967-54d00bfb6791" }, { "name": "List followers of a deal", "id": "f7d6120a-1dcf-4a87-b142-d056c09c4916", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/followers", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "followers" ], "variable": [ { "id": "09633f97-5f25-4a34-89fa-438c8b25ea31", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Lists the followers of a deal." }, "response": [ { "id": "bca59c07-e885-4526-a234-755b789c7d3a", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/followers", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "followers" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"user_id\": \"\",\n \"id\": \"\",\n \"deal_id\": \"\",\n \"add_time\": \"\"\n },\n {\n \"user_id\": \"\",\n \"id\": \"\",\n \"deal_id\": \"\",\n \"add_time\": \"\"\n }\n ],\n \"additional_data\": {\n \"start\": \"\",\n \"limit\": \"\",\n \"more_items_in_collection\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-bca59c07-e885-4526-a234-755b789c7d3a" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-f7d6120a-1dcf-4a87-b142-d056c09c4916" }, { "name": "Add a follower to a deal", "id": "1a083cc7-bff9-4d54-9b31-70ca4ab7a6d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals/:id/followers", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "followers" ], "variable": [ { "id": "c5423d07-8e5b-4249-899d-e7109029e1bc", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Adds a follower to a deal." }, "response": [ { "id": "68a82c7c-3155-4a1f-b21e-6c0dbeae9653", "name": "Add a follower to a deal", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals/:id/followers", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "followers" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"user_id\": \"\",\n \"id\": \"\",\n \"deal_id\": \"\",\n \"add_time\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-68a82c7c-3155-4a1f-b21e-6c0dbeae9653" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-1a083cc7-bff9-4d54-9b31-70ca4ab7a6d2" } ], "id": "5814dcc6-7424-4c27-946e-60e9e573a967", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-5814dcc6-7424-4c27-946e-60e9e573a967" }, { "name": "mailMessages", "item": [ { "name": "List mail messages associated with a deal", "id": "0132ab4b-f970-425e-b777-478b65c06f88", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/mailMessages?start=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "mailMessages" ], "query": [ { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page", "key": "limit", "value": "" } ], "variable": [ { "id": "3232863b-4866-41c6-82df-cfd7722abf0d", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Lists mail messages associated with a deal." }, "response": [ { "id": "cb625250-69e3-4fd9-b016-f8d569c6e6c9", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/mailMessages?start=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "mailMessages" ], "query": [ { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page", "key": "limit", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"object\": \"\",\n \"timestamp\": \"\",\n \"data\": {\n \"id\": \"\",\n \"from\": [\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n },\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n }\n ],\n \"to\": [\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n },\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n }\n ],\n \"cc\": [\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n },\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n },\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n }\n ],\n \"body_url\": \"\",\n \"account_id\": \"\",\n \"user_id\": \"\",\n \"mail_thread_id\": \"\",\n \"subject\": \"\",\n \"snippet\": \"\",\n \"mail_tracking_status\": \"not opened\",\n \"mail_link_tracking_enabled_flag\": 0,\n \"read_flag\": 0,\n \"draft\": \"\",\n \"draft_flag\": 0,\n \"synced_flag\": 0,\n \"deleted_flag\": 0,\n \"has_body_flag\": 0,\n \"sent_flag\": 0,\n \"sent_from_pipedrive_flag\": 0,\n \"smart_bcc_flag\": 0,\n \"message_time\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"has_attachments_flag\": 0,\n \"has_inline_attachments_flag\": 0,\n \"has_real_attachments_flag\": 0,\n \"nylas_id\": \"\",\n \"s3_bucket\": \"\",\n \"s3_bucket_path\": \"\",\n \"external_deleted_flag\": \"\",\n \"mua_message_id\": \"\",\n \"template_id\": \"\",\n \"timestamp\": \"\",\n \"item_type\": \"\",\n \"company_id\": \"\"\n }\n },\n {\n \"object\": \"\",\n \"timestamp\": \"\",\n \"data\": {\n \"id\": \"\",\n \"from\": [\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n },\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n }\n ],\n \"to\": [\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n },\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n }\n ],\n \"cc\": [\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n },\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n },\n {\n \"id\": \"\",\n \"email_address\": \"\",\n \"name\": \"\",\n \"linked_person_id\": \"\",\n \"linked_person_name\": \"\",\n \"mail_message_party_id\": \"\"\n }\n ],\n \"body_url\": \"\",\n \"account_id\": \"\",\n \"user_id\": \"\",\n \"mail_thread_id\": \"\",\n \"subject\": \"\",\n \"snippet\": \"\",\n \"mail_tracking_status\": \"opened\",\n \"mail_link_tracking_enabled_flag\": 0,\n \"read_flag\": 0,\n \"draft\": \"\",\n \"draft_flag\": 0,\n \"synced_flag\": 0,\n \"deleted_flag\": 0,\n \"has_body_flag\": 0,\n \"sent_flag\": 0,\n \"sent_from_pipedrive_flag\": 0,\n \"smart_bcc_flag\": 0,\n \"message_time\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"has_attachments_flag\": 0,\n \"has_inline_attachments_flag\": 0,\n \"has_real_attachments_flag\": 0,\n \"nylas_id\": \"\",\n \"s3_bucket\": \"\",\n \"s3_bucket_path\": \"\",\n \"external_deleted_flag\": \"\",\n \"mua_message_id\": \"\",\n \"template_id\": \"\",\n \"timestamp\": \"\",\n \"item_type\": \"\",\n \"company_id\": \"\"\n }\n }\n ],\n \"additional_data\": {\n \"start\": \"\",\n \"limit\": \"\",\n \"more_items_in_collection\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-cb625250-69e3-4fd9-b016-f8d569c6e6c9" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-0132ab4b-f970-425e-b777-478b65c06f88" } ], "id": "c6218e98-6b55-4f47-8477-5648dfb10b44", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-c6218e98-6b55-4f47-8477-5648dfb10b44" }, { "name": "merge", "item": [ { "name": "Merge two deals", "id": "3ce5c29e-fd2a-47ca-b828-dd07fff0fd5b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"merge_with_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals/:id/merge", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "merge" ], "variable": [ { "id": "66c6d563-78de-43a5-898a-00635b8016fb", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Merges a deal with another deal. For more information, see the tutorial for merging two deals." }, "response": [ { "id": "f60edf21-75e2-4b68-ab2f-3c6cd9bc7a90", "name": "Merges a deal with another deal", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"merge_with_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals/:id/merge", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "merge" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"creator_user_id\": \"\",\n \"user_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"stage_id\": \"\",\n \"title\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"active\": \"\",\n \"deleted\": \"\",\n \"is_archived\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"next_activity_date\": \"\",\n \"next_activity_time\": \"\",\n \"next_activity_id\": \"\",\n \"last_activity_id\": \"\",\n \"last_activity_date\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"pipeline_id\": \"\",\n \"won_time\": \"\",\n \"first_won_time\": \"\",\n \"lost_time\": \"\",\n \"products_count\": \"\",\n \"files_count\": \"\",\n \"notes_count\": \"\",\n \"followers_count\": \"\",\n \"email_messages_count\": \"\",\n \"activities_count\": \"\",\n \"done_activities_count\": \"\",\n \"undone_activities_count\": \"\",\n \"participants_count\": \"\",\n \"expected_close_date\": \"\",\n \"last_incoming_mail_time\": \"\",\n \"last_outgoing_mail_time\": \"\",\n \"label\": \"\",\n \"stage_order_nr\": \"\",\n \"person_name\": \"\",\n \"org_name\": \"\",\n \"next_activity_subject\": \"\",\n \"next_activity_type\": \"\",\n \"next_activity_duration\": \"\",\n \"next_activity_note\": \"\",\n \"formatted_value\": \"\",\n \"weighted_value\": \"\",\n \"formatted_weighted_value\": \"\",\n \"weighted_value_currency\": \"\",\n \"rotten_time\": \"\",\n \"owner_name\": \"\",\n \"cc_email\": \"\",\n \"org_hidden\": \"\",\n \"person_hidden\": \"\",\n \"origin\": \"\",\n \"origin_id\": \"\",\n \"channel\": \"\",\n \"channel_id\": \"\",\n \"arr\": \"\",\n \"mrr\": \"\",\n \"acv\": \"\",\n \"arr_currency\": \"\",\n \"mrr_currency\": \"\",\n \"acv_currency\": \"\",\n \"merge_what_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-f60edf21-75e2-4b68-ab2f-3c6cd9bc7a90" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-3ce5c29e-fd2a-47ca-b828-dd07fff0fd5b" } ], "id": "1423fffb-0560-4ee3-b8c9-2aeada94181e", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-1423fffb-0560-4ee3-b8c9-2aeada94181e" }, { "name": "participants", "item": [ { "name": "{deal_participant_id}", "item": [ { "name": "Delete a participant from a deal", "id": "8dae27d9-5d8f-4c6a-9351-1d50b37c7d2b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/participants/:deal_participant_id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "participants", ":deal_participant_id" ], "variable": [ { "id": "5312235f-3687-4e09-bef9-e39494ed577f", "key": "id", "value": "", "description": "(Required) The ID of the deal" }, { "id": "d59a496f-5186-49b9-9ed5-10819c56a637", "key": "deal_participant_id", "value": "", "description": "(Required) The ID of the participant of the deal" } ] }, "description": "Deletes a participant from a deal." }, "response": [ { "id": "07453474-8d00-4225-9c9a-0a0037cd4127", "name": "Delete a participant from a deal", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/participants/:deal_participant_id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "participants", ":deal_participant_id" ], "variable": [ { "key": "id" }, { "key": "deal_participant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-07453474-8d00-4225-9c9a-0a0037cd4127" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-8dae27d9-5d8f-4c6a-9351-1d50b37c7d2b" } ], "id": "e224ff09-89b7-4a58-8c8d-7d4f707f9a4f", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-e224ff09-89b7-4a58-8c8d-7d4f707f9a4f" }, { "name": "List participants of a deal", "id": "6f6fcdc2-52e5-4a65-822f-0c84f01f4cae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/participants?start=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "participants" ], "query": [ { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page", "key": "limit", "value": "" } ], "variable": [ { "id": "b17d4584-1ea8-4131-83b6-4d5677ed70b7", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Lists the participants associated with a deal.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field." }, "response": [ { "id": "01257952-d56f-4f8f-ac55-7310f79c7d98", "name": "Get all deal participants by the DealID", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/participants?start=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "participants" ], "query": [ { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page", "key": "limit", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"person_id\": {\n \"active_flag\": \"\",\n \"name\": \"\",\n \"email\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"phone\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"owner_id\": \"\",\n \"company_id\": \"\",\n \"value\": \"\"\n },\n \"add_time\": \"\",\n \"active_flag\": \"\",\n \"related_item_data\": {\n \"deal_id\": \"\",\n \"title\": \"\"\n },\n \"person\": {\n \"id\": \"\",\n \"company_id\": \"\",\n \"active_flag\": \"\",\n \"phone\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"email\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"first_char\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"visible_to\": \"\",\n \"picture_id\": {\n \"id\": \"\",\n \"item_type\": \"\",\n \"item_id\": \"\",\n \"active_flag\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"added_by_user_id\": \"\",\n \"pictures\": {\n \"128\": \"\",\n \"512\": \"\"\n }\n },\n \"label\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"org_name\": \"\",\n \"owner_name\": \"\",\n \"cc_email\": \"\",\n \"owner_id\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"has_pic\": \"\",\n \"pic_hash\": \"\",\n \"active_flag\": \"\",\n \"value\": \"\"\n },\n \"org_id\": {\n \"name\": \"\",\n \"people_count\": \"\",\n \"owner_id\": \"\",\n \"address\": \"\",\n \"cc_email\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"value\": \"\",\n \"active_flag\": \"\"\n },\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email_messages_count\": \"\",\n \"activities_count\": \"\",\n \"done_activities_count\": \"\",\n \"undone_activities_count\": \"\",\n \"files_count\": \"\",\n \"notes_count\": \"\",\n \"followers_count\": \"\",\n \"last_incoming_mail_time\": \"\",\n \"last_outgoing_mail_time\": \"\",\n \"open_deals_count\": \"\",\n \"related_open_deals_count\": \"\",\n \"closed_deals_count\": \"\",\n \"related_closed_deals_count\": \"\",\n \"won_deals_count\": \"\",\n \"related_won_deals_count\": \"\",\n \"lost_deals_count\": \"\",\n \"related_lost_deals_count\": \"\",\n \"next_activity_date\": \"\",\n \"next_activity_time\": \"\",\n \"next_activity_id\": \"\",\n \"last_activity_id\": \"\",\n \"last_activity_date\": \"\"\n },\n \"added_by_user_id\": {\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"default_currency\": \"\",\n \"locale\": \"\",\n \"lang\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"activated\": \"\",\n \"last_login\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"has_created_company\": \"\",\n \"access\": [\n {\n \"app\": \"global\",\n \"admin\": \"\",\n \"permission_set_id\": \"\"\n },\n {\n \"app\": \"projects\",\n \"admin\": \"\",\n \"permission_set_id\": \"\"\n }\n ],\n \"active_flag\": \"\",\n \"timezone_name\": \"\",\n \"timezone_offset\": \"\",\n \"role_id\": \"\",\n \"icon_url\": \"\",\n \"is_you\": \"\",\n \"is_deleted\": \"\"\n }\n },\n \"related_item_type\": \"\",\n \"related_item_id\": \"\"\n },\n {\n \"id\": \"\",\n \"person_id\": {\n \"active_flag\": \"\",\n \"name\": \"\",\n \"email\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"phone\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"owner_id\": \"\",\n \"company_id\": \"\",\n \"value\": \"\"\n },\n \"add_time\": \"\",\n \"active_flag\": \"\",\n \"related_item_data\": {\n \"deal_id\": \"\",\n \"title\": \"\"\n },\n \"person\": {\n \"id\": \"\",\n \"company_id\": \"\",\n \"active_flag\": \"\",\n \"phone\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"email\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"first_char\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"visible_to\": \"\",\n \"picture_id\": {\n \"id\": \"\",\n \"item_type\": \"\",\n \"item_id\": \"\",\n \"active_flag\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"added_by_user_id\": \"\",\n \"pictures\": {\n \"128\": \"\",\n \"512\": \"\"\n }\n },\n \"label\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"org_name\": \"\",\n \"owner_name\": \"\",\n \"cc_email\": \"\",\n \"owner_id\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"has_pic\": \"\",\n \"pic_hash\": \"\",\n \"active_flag\": \"\",\n \"value\": \"\"\n },\n \"org_id\": {\n \"name\": \"\",\n \"people_count\": \"\",\n \"owner_id\": \"\",\n \"address\": \"\",\n \"cc_email\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"value\": \"\",\n \"active_flag\": \"\"\n },\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email_messages_count\": \"\",\n \"activities_count\": \"\",\n \"done_activities_count\": \"\",\n \"undone_activities_count\": \"\",\n \"files_count\": \"\",\n \"notes_count\": \"\",\n \"followers_count\": \"\",\n \"last_incoming_mail_time\": \"\",\n \"last_outgoing_mail_time\": \"\",\n \"open_deals_count\": \"\",\n \"related_open_deals_count\": \"\",\n \"closed_deals_count\": \"\",\n \"related_closed_deals_count\": \"\",\n \"won_deals_count\": \"\",\n \"related_won_deals_count\": \"\",\n \"lost_deals_count\": \"\",\n \"related_lost_deals_count\": \"\",\n \"next_activity_date\": \"\",\n \"next_activity_time\": \"\",\n \"next_activity_id\": \"\",\n \"last_activity_id\": \"\",\n \"last_activity_date\": \"\"\n },\n \"added_by_user_id\": {\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"default_currency\": \"\",\n \"locale\": \"\",\n \"lang\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"activated\": \"\",\n \"last_login\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"has_created_company\": \"\",\n \"access\": [\n {\n \"app\": \"account_settings\",\n \"admin\": \"\",\n \"permission_set_id\": \"\"\n },\n {\n \"app\": \"account_settings\",\n \"admin\": \"\",\n \"permission_set_id\": \"\"\n }\n ],\n \"active_flag\": \"\",\n \"timezone_name\": \"\",\n \"timezone_offset\": \"\",\n \"role_id\": \"\",\n \"icon_url\": \"\",\n \"is_you\": \"\",\n \"is_deleted\": \"\"\n }\n },\n \"related_item_type\": \"\",\n \"related_item_id\": \"\"\n }\n ],\n \"additional_data\": {\n \"start\": \"\",\n \"limit\": \"\",\n \"more_items_in_collection\": \"\"\n },\n \"related_objects\": {\n \"user\": {\n \"USER_ID\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"has_pic\": \"\",\n \"pic_hash\": \"\",\n \"active_flag\": \"\"\n }\n },\n \"organization\": {\n \"ORGANIZATION_ID\": {\n \"active_flag\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"people_count\": \"\",\n \"owner_id\": \"\",\n \"address\": \"\",\n \"cc_email\": \"\"\n }\n },\n \"person\": {\n \"PERSON_ID\": {\n \"active_flag\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"phone\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"owner_id\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-01257952-d56f-4f8f-ac55-7310f79c7d98" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-6f6fcdc2-52e5-4a65-822f-0c84f01f4cae" }, { "name": "Add a participant to a deal", "id": "85c1c51e-5ed4-4910-bb5c-92285e5fc15e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"person_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals/:id/participants", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "participants" ], "variable": [ { "id": "deaae9ce-eea1-4f87-bd21-ed7a8affd289", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Adds a participant to a deal." }, "response": [ { "id": "8d21e392-c6a9-47fd-9742-b51aeb992db8", "name": "Add new participant to the deal", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"person_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals/:id/participants", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "participants" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"person_id\": {\n \"active_flag\": \"\",\n \"name\": \"\",\n \"email\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"phone\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"owner_id\": \"\",\n \"company_id\": \"\",\n \"value\": \"\"\n },\n \"add_time\": \"\",\n \"active_flag\": \"\",\n \"related_item_data\": {\n \"deal_id\": \"\",\n \"title\": \"\"\n },\n \"person\": {\n \"id\": \"\",\n \"company_id\": \"\",\n \"active_flag\": \"\",\n \"phone\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"email\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"first_char\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"visible_to\": \"\",\n \"picture_id\": {\n \"id\": \"\",\n \"item_type\": \"\",\n \"item_id\": \"\",\n \"active_flag\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"added_by_user_id\": \"\",\n \"pictures\": {\n \"128\": \"\",\n \"512\": \"\"\n }\n },\n \"label\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"org_name\": \"\",\n \"owner_name\": \"\",\n \"cc_email\": \"\",\n \"owner_id\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"has_pic\": \"\",\n \"pic_hash\": \"\",\n \"active_flag\": \"\",\n \"value\": \"\"\n },\n \"org_id\": {\n \"name\": \"\",\n \"people_count\": \"\",\n \"owner_id\": \"\",\n \"address\": \"\",\n \"cc_email\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"value\": \"\",\n \"active_flag\": \"\"\n },\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email_messages_count\": \"\",\n \"activities_count\": \"\",\n \"done_activities_count\": \"\",\n \"undone_activities_count\": \"\",\n \"files_count\": \"\",\n \"notes_count\": \"\",\n \"followers_count\": \"\",\n \"last_incoming_mail_time\": \"\",\n \"last_outgoing_mail_time\": \"\",\n \"open_deals_count\": \"\",\n \"related_open_deals_count\": \"\",\n \"closed_deals_count\": \"\",\n \"related_closed_deals_count\": \"\",\n \"won_deals_count\": \"\",\n \"related_won_deals_count\": \"\",\n \"lost_deals_count\": \"\",\n \"related_lost_deals_count\": \"\",\n \"next_activity_date\": \"\",\n \"next_activity_time\": \"\",\n \"next_activity_id\": \"\",\n \"last_activity_id\": \"\",\n \"last_activity_date\": \"\"\n },\n \"added_by_user_id\": {\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"default_currency\": \"\",\n \"locale\": \"\",\n \"lang\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"activated\": \"\",\n \"last_login\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"has_created_company\": \"\",\n \"access\": [\n {\n \"app\": \"sales\",\n \"admin\": \"\",\n \"permission_set_id\": \"\"\n },\n {\n \"app\": \"account_settings\",\n \"admin\": \"\",\n \"permission_set_id\": \"\"\n }\n ],\n \"active_flag\": \"\",\n \"timezone_name\": \"\",\n \"timezone_offset\": \"\",\n \"role_id\": \"\",\n \"icon_url\": \"\",\n \"is_you\": \"\",\n \"is_deleted\": \"\"\n }\n },\n \"related_item_type\": \"\",\n \"related_item_id\": \"\"\n },\n \"related_objects\": {\n \"user\": {\n \"USER_ID\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"has_pic\": \"\",\n \"pic_hash\": \"\",\n \"active_flag\": \"\"\n }\n },\n \"person\": {\n \"PERSON_ID\": {\n \"active_flag\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"phone\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"owner_id\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-8d21e392-c6a9-47fd-9742-b51aeb992db8" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-85c1c51e-5ed4-4910-bb5c-92285e5fc15e" } ], "id": "3038e1ca-6b0d-400e-b7e7-340a8f563dd7", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-3038e1ca-6b0d-400e-b7e7-340a8f563dd7" }, { "name": "permittedUsers", "item": [ { "name": "List permitted users", "id": "dcd06b3e-3de7-4993-9631-ad21165c66a5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/permittedUsers", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "permittedUsers" ], "variable": [ { "id": "125ef4bf-f1e1-4ab7-90db-0927ed30bdb8", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Lists the users permitted to access a deal." }, "response": [ { "id": "2cc75280-c7bf-4d28-ae2a-05f629d16068", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/permittedUsers", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "permittedUsers" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\"\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-2cc75280-c7bf-4d28-ae2a-05f629d16068" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-dcd06b3e-3de7-4993-9631-ad21165c66a5" } ], "id": "ee4c7bca-1dc5-440d-b8f8-c03f6e3ab0c0", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-ee4c7bca-1dc5-440d-b8f8-c03f6e3ab0c0" }, { "name": "discounts", "item": [ { "name": "{discount_id}", "item": [ { "name": "Update a discount added to a deal", "id": "f4f851ad-2178-4193-8dda-ae046a50db11", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals/:id/discounts/:discount_id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "discounts", ":discount_id" ], "variable": [ { "id": "6f9b7c09-98fd-4ea6-8eb4-c42aaaeae5aa", "key": "id", "value": "", "description": "(Required) The ID of the deal" }, { "id": "fe3b9529-aeb7-4fe3-9041-380a19fc05a7", "key": "discount_id", "value": "", "description": "(Required) The ID of the discount" } ] }, "description": "Edits a discount added to a deal, changing the deal value if the deal has one-time products attached." }, "response": [ { "id": "ee06db10-3def-4020-ac75-c5370b89e060", "name": "Edited discount.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals/:id/discounts/:discount_id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "discounts", ":discount_id" ], "variable": [ { "key": "id" }, { "key": "discount_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"type\": \"amount\",\n \"amount\": \"\",\n \"description\": \"\",\n \"deal_id\": \"\",\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-ee06db10-3def-4020-ac75-c5370b89e060" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-f4f851ad-2178-4193-8dda-ae046a50db11" }, { "name": "Delete a discount from a deal", "id": "aac54e8d-b6cd-4deb-8430-1f6ba89427fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/discounts/:discount_id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "discounts", ":discount_id" ], "variable": [ { "id": "2df7bdeb-f17d-49a0-98f8-b05e391ac34d", "key": "id", "value": "", "description": "(Required) The ID of the deal" }, { "id": "501c47a7-a1c4-4cc5-aa15-c9aebb20e9d0", "key": "discount_id", "value": "", "description": "(Required) The ID of the discount" } ] }, "description": "Removes a discount from a deal, changing the deal value if the deal has one-time products attached." }, "response": [ { "id": "c2bc92f1-08dc-42af-b391-5cb35179b5c0", "name": "The ID of the deleted discount.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/discounts/:discount_id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "discounts", ":discount_id" ], "variable": [ { "key": "id" }, { "key": "discount_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-c2bc92f1-08dc-42af-b391-5cb35179b5c0" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-aac54e8d-b6cd-4deb-8430-1f6ba89427fd" } ], "id": "f12d98ce-cbf3-41d5-8e85-a5d0ded2e30e", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-f12d98ce-cbf3-41d5-8e85-a5d0ded2e30e" }, { "name": "List discounts added to a deal", "id": "270d2e2a-d8f0-45df-92e9-37d0fdf1f7d8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/discounts", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "discounts" ], "variable": [ { "id": "02ef7fec-cd46-4c16-94e9-f5b401fd7de8", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Lists discounts attached to a deal." }, "response": [ { "id": "de131735-94fa-4cea-9b41-01f4e22704d2", "name": "List of discounts added to deal", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/discounts", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "discounts" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"percentage\",\n \"amount\": \"\",\n \"description\": \"\",\n \"deal_id\": \"\",\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"percentage\",\n \"amount\": \"\",\n \"description\": \"\",\n \"deal_id\": \"\",\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-de131735-94fa-4cea-9b41-01f4e22704d2" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-270d2e2a-d8f0-45df-92e9-37d0fdf1f7d8" }, { "name": "Add a discount to a deal", "id": "9fca38fd-6344-408b-8b74-64c47666cfbd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals/:id/discounts", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "discounts" ], "variable": [ { "id": "e69b7067-2df5-45b4-bf23-86fbe643b750", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Adds a discount to a deal, changing the deal value if the deal has one-time products attached." }, "response": [ { "id": "80108457-fa04-408d-8a2e-3dab608f60f4", "name": "Discount added to deal", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals/:id/discounts", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "discounts" ], "variable": [ { "key": "id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"type\": \"percentage\",\n \"amount\": \"\",\n \"description\": \"\",\n \"deal_id\": \"\",\n \"created_at\": \"\",\n \"created_by\": \"\",\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-80108457-fa04-408d-8a2e-3dab608f60f4" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-9fca38fd-6344-408b-8b74-64c47666cfbd" } ], "id": "606817a7-28e3-4995-9ad5-ecb41a13a267", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-606817a7-28e3-4995-9ad5-ecb41a13a267" }, { "name": "convert", "item": [ { "name": "lead", "item": [ { "name": "Convert a deal to a lead", "id": "b0a9e383-f32c-4c9c-b6ba-dad4812ff79c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/convert/lead", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "convert", "lead" ], "variable": [ { "id": "8fdaad5d-94bc-4aca-af7b-6098541d6010", "key": "id", "value": "", "description": "(Required) The ID of the deal to convert" } ] }, "description": "Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the /api/v2/deals/{deal_id}/convert/status/{conversion_id} endpoint." }, "response": [ { "id": "057dfb7a-4def-42c4-a02a-d6aeacb74533", "name": "Successful response containing payload in the `data` field", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/convert/lead", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "convert", "lead" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"conversion_id\": \"\"\n },\n \"additional_data\": {}\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-057dfb7a-4def-42c4-a02a-d6aeacb74533" }, { "id": "55f0df35-922f-4b68-8be3-9dddb4d85208", "name": "A resource describing an error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/convert/lead", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "convert", "lead" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"error\": \"\",\n \"error_info\": \"\",\n \"data\": {},\n \"additional_data\": {}\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-55f0df35-922f-4b68-8be3-9dddb4d85208" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-b0a9e383-f32c-4c9c-b6ba-dad4812ff79c" } ], "id": "90f24088-9379-4986-8869-a52d60af0568", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-90f24088-9379-4986-8869-a52d60af0568" }, { "name": "status", "item": [ { "name": "{conversion_id}", "item": [ { "name": "Get Deal conversion status", "id": "5c95cbca-b095-40ef-98f3-0e07d01a0908", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/convert/status/:conversion_id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "convert", "status", ":conversion_id" ], "variable": [ { "id": "6fca83f0-36b5-48fe-837d-577f888cb4ba", "key": "id", "value": "", "description": "(Required) The ID of a deal" }, { "id": "2a9f8a47-0747-47ef-97e4-99cc13e8eeb0", "key": "conversion_id", "value": "", "description": "(Required) The ID of the conversion" } ] }, "description": "Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days." }, "response": [ { "id": "e7281a94-653f-454b-b143-61b23fde538b", "name": "Successful response containing payload in the `data` field", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/convert/status/:conversion_id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "convert", "status", ":conversion_id" ], "variable": [ { "key": "id" }, { "key": "conversion_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"conversion_id\": \"\",\n \"status\": \"not_started\",\n \"lead_id\": \"\",\n \"deal_id\": \"\"\n },\n \"additional_data\": {}\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-e7281a94-653f-454b-b143-61b23fde538b" }, { "id": "c7fb187c-ee96-453c-96d5-7622393ad4f2", "name": "A resource describing an error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id/convert/status/:conversion_id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "convert", "status", ":conversion_id" ], "variable": [ { "key": "id" }, { "key": "conversion_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"error\": \"\",\n \"error_info\": \"\",\n \"data\": {},\n \"additional_data\": {}\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-c7fb187c-ee96-453c-96d5-7622393ad4f2" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-5c95cbca-b095-40ef-98f3-0e07d01a0908" } ], "id": "136d4670-63f2-487c-b2f2-2471546a51e1", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-136d4670-63f2-487c-b2f2-2471546a51e1" } ], "id": "1bc8cc08-b248-42e9-8436-6eb2968c718e", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-1bc8cc08-b248-42e9-8436-6eb2968c718e" } ], "id": "71a3b06c-4f63-4d9f-a71a-4bdd9106fd05", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-71a3b06c-4f63-4d9f-a71a-4bdd9106fd05" }, { "name": "Delete a deal", "id": "844c7ca3-753f-4d0c-9f26-b68f39f8df4b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id" ], "variable": [ { "id": "fd0400dd-bd74-4595-be96-3a12ede208a6", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Marks a deal as deleted. After 30 days, the deal will be permanently deleted." }, "response": [ { "id": "96652643-f687-4903-8e85-fcfca52cc698", "name": "Delete deal", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-96652643-f687-4903-8e85-fcfca52cc698" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-844c7ca3-753f-4d0c-9f26-b68f39f8df4b" }, { "name": "Get details of a deal", "id": "4cff27d8-72fe-4784-811a-182c77f7cc32", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id?include_fields=last_incoming_mail_time&custom_fields=&include_option_labels=&include_labels=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id" ], "query": [ { "description": "Optional comma separated string array of additional fields to include", "key": "include_fields", "value": "last_incoming_mail_time" }, { "description": "Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.", "key": "custom_fields", "value": "" }, { "description": "When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id", "key": "include_option_labels", "value": "" }, { "description": "When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'", "key": "include_labels", "value": "" } ], "variable": [ { "id": "52a48241-0e68-4eae-8efc-561872af7827", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Returns the details of a specific deal." }, "response": [ { "id": "4d7c5baf-9014-4547-ab77-a34a97cc7b93", "name": "Get deal", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/:id?include_fields=last_incoming_mail_time&custom_fields=&include_option_labels=&include_labels=", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id" ], "query": [ { "description": "Optional comma separated string array of additional fields to include", "key": "include_fields", "value": "last_incoming_mail_time" }, { "description": "Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.", "key": "custom_fields", "value": "" }, { "description": "When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id", "key": "include_option_labels", "value": "" }, { "description": "When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'", "key": "include_labels", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"title\": \"\",\n \"owner_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"pipeline_id\": \"\",\n \"stage_id\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"is_deleted\": \"\",\n \"is_archived\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"won_time\": \"\",\n \"lost_time\": \"\",\n \"expected_close_date\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"origin\": \"\",\n \"origin_id\": \"\",\n \"channel\": \"\",\n \"channel_id\": \"\",\n \"source_lead_id\": \"\",\n \"arr\": \"\",\n \"mrr\": \"\",\n \"acv\": \"\",\n \"custom_fields\": {\n \"quibca\": 72864584.50920752,\n \"esse_67\": \"in aliqua proident\",\n \"esse4\": \"in sunt officia veniam aliquip\",\n \"in_104\": -93925034\n }\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-4d7c5baf-9014-4547-ab77-a34a97cc7b93" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-4cff27d8-72fe-4784-811a-182c77f7cc32" }, { "name": "Update a deal", "id": "06be3730-95ec-4397-95c6-cd876f9f713c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"owner_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"pipeline_id\": \"\",\n \"stage_id\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"is_deleted\": \"\",\n \"is_archived\": \"\",\n \"archive_time\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"won_time\": \"\",\n \"lost_time\": \"\",\n \"expected_close_date\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": {\n \"minim8a_\": 98217077.16534096,\n \"nisi_17\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals/:id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id" ], "variable": [ { "id": "82d17f12-2861-43d3-8d5d-343bc5177530", "key": "id", "value": "", "description": "(Required) The ID of the deal" } ] }, "description": "Updates the properties of a deal." }, "response": [ { "id": "e1432edb-0434-40c9-a314-7bfd92faeb9c", "name": "Edit deal", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"owner_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"pipeline_id\": \"\",\n \"stage_id\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"is_deleted\": \"\",\n \"is_archived\": \"\",\n \"archive_time\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"won_time\": \"\",\n \"lost_time\": \"\",\n \"expected_close_date\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": {\n \"minim8a_\": 98217077.16534096,\n \"nisi_17\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals/:id", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"title\": \"\",\n \"owner_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"pipeline_id\": \"\",\n \"stage_id\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"is_deleted\": \"\",\n \"is_archived\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"won_time\": \"\",\n \"lost_time\": \"\",\n \"expected_close_date\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"origin\": \"\",\n \"origin_id\": \"\",\n \"channel\": \"\",\n \"channel_id\": \"\",\n \"source_lead_id\": \"\",\n \"arr\": \"\",\n \"mrr\": \"\",\n \"acv\": \"\",\n \"custom_fields\": {\n \"quibca\": 72864584.50920752,\n \"esse_67\": \"in aliqua proident\",\n \"esse4\": \"in sunt officia veniam aliquip\",\n \"in_104\": -93925034\n }\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-e1432edb-0434-40c9-a314-7bfd92faeb9c" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-06be3730-95ec-4397-95c6-cd876f9f713c" } ], "id": "8c6fcd74-0308-4dc9-8b6d-68a5dfcf1d79", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-8c6fcd74-0308-4dc9-8b6d-68a5dfcf1d79" }, { "name": "search", "item": [ { "name": "Search deals", "id": "9c3670db-660c-4ed7-b7aa-1a2859c7c65f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/search?term=&fields=title&exact_match=&person_id=&organization_id=&status=lost&include_fields=deal.cc_email&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "deals", "search" ], "query": [ { "description": "(Required) The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.", "key": "term", "value": "" }, { "description": "A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields here.", "key": "fields", "value": "title" }, { "description": "When enabled, only full exact matches against the given term are returned. It is not case sensitive.", "key": "exact_match", "value": "" }, { "description": "Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.", "key": "person_id", "value": "" }, { "description": "Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.", "key": "organization_id", "value": "" }, { "description": "Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.", "key": "status", "value": "lost" }, { "description": "Supports including optional fields in the results which are not provided by default", "key": "include_fields", "value": "deal.cc_email" }, { "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.", "key": "limit", "value": "" }, { "description": "For pagination, the marker (an opaque string value) representing the first item on the next page", "key": "cursor", "value": "" } ] }, "description": "Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID." }, "response": [ { "id": "6bbcc390-49aa-4ca5-af44-95606064769f", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals/search?term=&fields=title&exact_match=&person_id=&organization_id=&status=lost&include_fields=deal.cc_email&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "deals", "search" ], "query": [ { "description": "(Required) The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.", "key": "term", "value": "" }, { "description": "A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields here.", "key": "fields", "value": "title" }, { "description": "When enabled, only full exact matches against the given term are returned. It is not case sensitive.", "key": "exact_match", "value": "" }, { "description": "Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.", "key": "person_id", "value": "" }, { "description": "Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.", "key": "organization_id", "value": "" }, { "description": "Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.", "key": "status", "value": "lost" }, { "description": "Supports including optional fields in the results which are not provided by default", "key": "include_fields", "value": "deal.cc_email" }, { "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.", "key": "limit", "value": "" }, { "description": "For pagination, the marker (an opaque string value) representing the first item on the next page", "key": "cursor", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"items\": [\n {\n \"result_score\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"visible_to\": \"\",\n \"owner\": {\n \"id\": \"\"\n },\n \"stage\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"person\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"organization\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"custom_fields\": [\n \"\",\n \"\"\n ],\n \"notes\": [\n \"\",\n \"\"\n ],\n \"is_archived\": \"\"\n }\n },\n {\n \"result_score\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"visible_to\": \"\",\n \"owner\": {\n \"id\": \"\"\n },\n \"stage\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"person\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"organization\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"custom_fields\": [\n \"\",\n \"\"\n ],\n \"notes\": [\n \"\",\n \"\"\n ],\n \"is_archived\": \"\"\n }\n }\n ]\n },\n \"additional_data\": {\n \"next_cursor\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-6bbcc390-49aa-4ca5-af44-95606064769f" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-9c3670db-660c-4ed7-b7aa-1a2859c7c65f" } ], "id": "bb6b6970-3802-4172-9241-6625eb44df45", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-bb6b6970-3802-4172-9241-6625eb44df45" }, { "name": "Get all deals", "id": "d073e007-ee91-4987-a541-252774b065fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals?filter_id=&ids=&owner_id=&person_id=&org_id=&pipeline_id=&stage_id=&status=won&updated_since=&updated_until=&sort_by=id&sort_direction=asc&include_fields=last_incoming_mail_time&custom_fields=&include_option_labels=&include_labels=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "deals" ], "query": [ { "description": "If supplied, only deals matching the specified filter are returned", "key": "filter_id", "value": "" }, { "description": "Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.", "key": "ids", "value": "" }, { "description": "If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.", "key": "owner_id", "value": "" }, { "description": "If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.", "key": "person_id", "value": "" }, { "description": "If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.", "key": "org_id", "value": "" }, { "description": "If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.", "key": "pipeline_id", "value": "" }, { "description": "If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.", "key": "stage_id", "value": "" }, { "description": "Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.", "key": "status", "value": "won" }, { "description": "If set, only deals with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.", "key": "updated_since", "value": "" }, { "description": "If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.", "key": "updated_until", "value": "" }, { "description": "The field to sort by. Supported fields: `id`, `update_time`, `add_time`.", "key": "sort_by", "value": "id" }, { "description": "The sorting direction. Supported values: `asc`, `desc`.", "key": "sort_direction", "value": "asc" }, { "description": "Optional comma separated string array of additional fields to include", "key": "include_fields", "value": "last_incoming_mail_time" }, { "description": "Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.", "key": "custom_fields", "value": "" }, { "description": "When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id", "key": "include_option_labels", "value": "" }, { "description": "When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'", "key": "include_labels", "value": "" }, { "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.", "key": "limit", "value": "" }, { "description": "For pagination, the marker (an opaque string value) representing the first item on the next page", "key": "cursor", "value": "" } ] }, "description": "Returns data about all not archived deals." }, "response": [ { "id": "93eba238-e54c-4c8e-b3d9-b564d5b17e77", "name": "Get all not archived deals", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/deals?filter_id=&ids=&owner_id=&person_id=&org_id=&pipeline_id=&stage_id=&status=won&updated_since=&updated_until=&sort_by=id&sort_direction=asc&include_fields=last_incoming_mail_time&custom_fields=&include_option_labels=&include_labels=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "deals" ], "query": [ { "description": "If supplied, only deals matching the specified filter are returned", "key": "filter_id", "value": "" }, { "description": "Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.", "key": "ids", "value": "" }, { "description": "If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.", "key": "owner_id", "value": "" }, { "description": "If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.", "key": "person_id", "value": "" }, { "description": "If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.", "key": "org_id", "value": "" }, { "description": "If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.", "key": "pipeline_id", "value": "" }, { "description": "If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.", "key": "stage_id", "value": "" }, { "description": "Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.", "key": "status", "value": "won" }, { "description": "If set, only deals with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.", "key": "updated_since", "value": "" }, { "description": "If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.", "key": "updated_until", "value": "" }, { "description": "The field to sort by. Supported fields: `id`, `update_time`, `add_time`.", "key": "sort_by", "value": "id" }, { "description": "The sorting direction. Supported values: `asc`, `desc`.", "key": "sort_direction", "value": "asc" }, { "description": "Optional comma separated string array of additional fields to include", "key": "include_fields", "value": "last_incoming_mail_time" }, { "description": "Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.", "key": "custom_fields", "value": "" }, { "description": "When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id", "key": "include_option_labels", "value": "" }, { "description": "When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'", "key": "include_labels", "value": "" }, { "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.", "key": "limit", "value": "" }, { "description": "For pagination, the marker (an opaque string value) representing the first item on the next page", "key": "cursor", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"owner_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"pipeline_id\": \"\",\n \"stage_id\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"is_deleted\": \"\",\n \"is_archived\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"won_time\": \"\",\n \"lost_time\": \"\",\n \"expected_close_date\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"origin\": \"\",\n \"origin_id\": \"\",\n \"channel\": \"\",\n \"channel_id\": \"\",\n \"source_lead_id\": \"\",\n \"arr\": \"\",\n \"mrr\": \"\",\n \"acv\": \"\",\n \"custom_fields\": {\n \"in_573\": \"ad ea fugiat sit\",\n \"ind5\": \"dolor sint et\"\n }\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"owner_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"pipeline_id\": \"\",\n \"stage_id\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"is_deleted\": \"\",\n \"is_archived\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"won_time\": \"\",\n \"lost_time\": \"\",\n \"expected_close_date\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"origin\": \"\",\n \"origin_id\": \"\",\n \"channel\": \"\",\n \"channel_id\": \"\",\n \"source_lead_id\": \"\",\n \"arr\": \"\",\n \"mrr\": \"\",\n \"acv\": \"\",\n \"custom_fields\": {\n \"eiusmod_8a1\": \"consectetur aliqua culpa\"\n }\n }\n ],\n \"additional_data\": {\n \"next_cursor\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-93eba238-e54c-4c8e-b3d9-b564d5b17e77" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-d073e007-ee91-4987-a541-252774b065fe" }, { "name": "Add a new deal", "id": "9b2bbf48-205f-4f6c-a781-a77dccac3402", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"owner_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"pipeline_id\": \"\",\n \"stage_id\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"is_deleted\": \"\",\n \"is_archived\": \"\",\n \"archive_time\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"won_time\": \"\",\n \"lost_time\": \"\",\n \"expected_close_date\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": {\n \"commodoa\": true,\n \"non_5b\": -74509743.39760736,\n \"enim_52\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals", "host": [ "{{baseUrl}}" ], "path": [ "deals" ] }, "description": "Adds a new deal." }, "response": [ { "id": "5fc14606-d2be-4c09-9716-37869884cea9", "name": "Add deal", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"owner_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"pipeline_id\": \"\",\n \"stage_id\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"is_deleted\": \"\",\n \"is_archived\": \"\",\n \"archive_time\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"won_time\": \"\",\n \"lost_time\": \"\",\n \"expected_close_date\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": {\n \"commodoa\": true,\n \"non_5b\": -74509743.39760736,\n \"enim_52\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/deals", "host": [ "{{baseUrl}}" ], "path": [ "deals" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"title\": \"\",\n \"owner_id\": \"\",\n \"person_id\": \"\",\n \"org_id\": \"\",\n \"pipeline_id\": \"\",\n \"stage_id\": \"\",\n \"value\": \"\",\n \"currency\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"is_deleted\": \"\",\n \"is_archived\": \"\",\n \"status\": \"\",\n \"probability\": \"\",\n \"lost_reason\": \"\",\n \"visible_to\": \"\",\n \"close_time\": \"\",\n \"won_time\": \"\",\n \"lost_time\": \"\",\n \"expected_close_date\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"origin\": \"\",\n \"origin_id\": \"\",\n \"channel\": \"\",\n \"channel_id\": \"\",\n \"source_lead_id\": \"\",\n \"arr\": \"\",\n \"mrr\": \"\",\n \"acv\": \"\",\n \"custom_fields\": {\n \"quibca\": 72864584.50920752,\n \"esse_67\": \"in aliqua proident\",\n \"esse4\": \"in sunt officia veniam aliquip\",\n \"in_104\": -93925034\n }\n }\n}", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-5fc14606-d2be-4c09-9716-37869884cea9" } ], "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-9b2bbf48-205f-4f6c-a781-a77dccac3402" } ], "id": "b8b6eb04-30b5-48d0-939c-29c8dc79a35c", "createdAt": "2026-07-28T02:37:20.000Z", "updatedAt": "2026-07-28T02:37:20.000Z", "uid": "35240-b8b6eb04-30b5-48d0-939c-29c8dc79a35c" } ], "variable": [ { "key": "baseUrl", "value": "https://api.pipedrive.com/v1" } ] }