{ "info": { "_postman_id": "f3104af8-fc06-4d92-910a-2e8731b7bb53", "name": "Pipedrive API v1 Activities Organizations 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:43.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "lastUpdatedBy": "35240", "uid": "35240-f3104af8-fc06-4d92-910a-2e8731b7bb53" }, "item": [ { "name": "organizations", "item": [ { "name": "{id}", "item": [ { "name": "changelog", "item": [ { "name": "List updates about organization field values", "id": "300f667d-f0ce-484a-b652-7821d5b613fd", "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}}/organizations/:id/changelog?cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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": "ecf86d14-2a89-4ead-9656-cf0958562af7", "key": "id", "value": "", "description": "(Required) The ID of the organization" } ] }, "description": "Lists updates about field values of an organization." }, "response": [ { "id": "df768724-803b-457e-a191-f4dda3a5f40a", "name": "Get changelog of an organization", "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}}/organizations/:id/changelog?cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-df768724-803b-457e-a191-f4dda3a5f40a" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-300f667d-f0ce-484a-b652-7821d5b613fd" } ], "id": "ece9164b-a8b7-444f-8fa3-28247c4cee6b", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-ece9164b-a8b7-444f-8fa3-28247c4cee6b" }, { "name": "files", "item": [ { "name": "List files attached to an organization", "id": "57fcd691-3069-4381-983e-62d756fc1e82", "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}}/organizations/:id/files?start=0&limit=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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": "174d1904-4d29-4e7a-b56e-fcca530d1183", "key": "id", "value": "", "description": "(Required) The ID of the organization" } ] }, "description": "Lists files associated with an organization." }, "response": [ { "id": "57c7bc77-813d-4c0b-9c21-a02c40330c29", "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}}/organizations/:id/files?start=0&limit=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-57c7bc77-813d-4c0b-9c21-a02c40330c29" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-57fcd691-3069-4381-983e-62d756fc1e82" } ], "id": "3bbb7817-9778-4b2d-9476-166d66f41e61", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-3bbb7817-9778-4b2d-9476-166d66f41e61" }, { "name": "flow", "item": [ { "name": "List updates about an organization", "id": "7911dd8f-4d69-46f1-bd27-4ab0432047f1", "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}}/organizations/:id/flow?start=0&limit=&all_changes=&items=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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 - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).", "key": "items", "value": "" } ], "variable": [ { "id": "00995833-238f-407d-8624-43acf7472d6b", "key": "id", "value": "", "description": "(Required) The ID of the organization" } ] }, "description": "Lists updates about an organization." }, "response": [ { "id": "8f9ffdfd-7183-464b-a1a4-6624181d65fa", "name": "Get the organization 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}}/organizations/:id/flow?start=0&limit=&all_changes=&items=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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 - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).", "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 \"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 }\n}", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-8f9ffdfd-7183-464b-a1a4-6624181d65fa" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-7911dd8f-4d69-46f1-bd27-4ab0432047f1" } ], "id": "3f47282d-51d5-4e1f-99cc-01482e224f29", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-3f47282d-51d5-4e1f-99cc-01482e224f29" }, { "name": "followers", "item": [ { "name": "{follower_id}", "item": [ { "name": "Delete a follower from an organization", "id": "91c022f1-e2a1-47cb-8765-d469bb05f626", "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}}/organizations/:id/followers/:follower_id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id", "followers", ":follower_id" ], "variable": [ { "id": "6fc1fe4f-afcc-4cfc-a08d-7e682bb039dd", "key": "id", "value": "", "description": "(Required) The ID of the organization" }, { "id": "0871f3bd-da6a-4e74-9e91-e9ecb64fa969", "key": "follower_id", "value": "", "description": "(Required) The ID of the relationship between the follower and the organization" } ] }, "description": "Deletes a follower from an organization. You can retrieve the `follower_id` from the List followers of an organization endpoint." }, "response": [ { "id": "e4f6917c-a315-435a-83f1-2b0ce303b1b0", "name": "Success", "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}}/organizations/:id/followers/:follower_id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-e4f6917c-a315-435a-83f1-2b0ce303b1b0" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-91c022f1-e2a1-47cb-8765-d469bb05f626" } ], "id": "e0dacd09-50be-4846-9ff7-f28d3d6550e3", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-e0dacd09-50be-4846-9ff7-f28d3d6550e3" }, { "name": "changelog", "item": [ { "name": "List followers changelog of an organization", "id": "6bdaebfd-91f6-496b-b46b-b5bbe4ca09dd", "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}}/organizations/:id/followers/changelog?limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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": "454cadb1-67f6-4a26-835a-0d70b83410b8", "key": "id", "value": "", "description": "(Required) The ID of the organization" } ] }, "description": "Lists changelogs about users have followed the organization." }, "response": [ { "id": "f7bd7143-ee04-44f3-bd4a-a93dd9ac4a90", "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}}/organizations/:id/followers/changelog?limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-f7bd7143-ee04-44f3-bd4a-a93dd9ac4a90" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-6bdaebfd-91f6-496b-b46b-b5bbe4ca09dd" } ], "id": "f348b337-1422-4e54-86a8-dbed2351b55d", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-f348b337-1422-4e54-86a8-dbed2351b55d" }, { "name": "List followers of an organization", "id": "10435aff-85a9-4efc-a2a8-12ffd5df6e46", "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}}/organizations/:id/followers", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id", "followers" ], "variable": [ { "id": "7b9eb06c-4487-46e5-865a-613970fceb89", "key": "id", "value": "", "description": "(Required) The ID of the organization" } ] }, "description": "Lists the followers of an organization." }, "response": [ { "id": "2e95dde5-62af-43c3-9786-adac27d9bb1d", "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}}/organizations/:id/followers", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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 \"org_id\": \"\",\n \"user_id\": \"\",\n \"id\": \"\",\n \"add_time\": \"\"\n },\n {\n \"org_id\": \"\",\n \"user_id\": \"\",\n \"id\": \"\",\n \"add_time\": \"\"\n }\n ],\n \"additional_data\": {\n \"pagination\": {\n \"start\": \"\",\n \"limit\": \"\",\n \"more_items_in_collection\": \"\",\n \"next_start\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-2e95dde5-62af-43c3-9786-adac27d9bb1d" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-10435aff-85a9-4efc-a2a8-12ffd5df6e46" }, { "name": "Add a follower to an organization", "id": "81cd5d79-4aec-4687-a092-b91671bca4b6", "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}}/organizations/:id/followers", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id", "followers" ], "variable": [ { "id": "edb894c1-7f2e-46b5-a0fb-19ae7ee64eef", "key": "id", "value": "", "description": "(Required) The ID of the organization" } ] }, "description": "Adds a follower to an organization." }, "response": [ { "id": "2f3cf677-a712-4cb0-bc6d-8fbed1e3476a", "name": "Success", "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}}/organizations/:id/followers", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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 \"org_id\": \"\",\n \"user_id\": \"\",\n \"id\": \"\",\n \"add_time\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-2f3cf677-a712-4cb0-bc6d-8fbed1e3476a" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-81cd5d79-4aec-4687-a092-b91671bca4b6" } ], "id": "0a0d4ffd-2ba2-450d-862c-7bec938d5aa7", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-0a0d4ffd-2ba2-450d-862c-7bec938d5aa7" }, { "name": "mailMessages", "item": [ { "name": "List mail messages associated with an organization", "id": "e20d7347-0699-4514-8f4d-79fba221b61f", "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}}/organizations/:id/mailMessages?start=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id", "mailMessages" ], "query": [ { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page", "key": "limit", "value": "" } ], "variable": [ { "id": "ba265af3-e310-4a09-b55f-2f005fbd1e13", "key": "id", "value": "", "description": "(Required) The ID of the organization" } ] }, "description": "Lists mail messages associated with an organization." }, "response": [ { "id": "0e323dc9-70ac-479b-ae4d-33a59b47b14e", "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}}/organizations/:id/mailMessages?start=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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\": \"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\": \"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 \"additional_data\": {\n \"start\": \"\",\n \"limit\": \"\",\n \"more_items_in_collection\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-0e323dc9-70ac-479b-ae4d-33a59b47b14e" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-e20d7347-0699-4514-8f4d-79fba221b61f" } ], "id": "94aac061-2239-48b7-a803-5db75ed2661d", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-94aac061-2239-48b7-a803-5db75ed2661d" }, { "name": "merge", "item": [ { "name": "Merge two organizations", "id": "2f00d838-1534-47d9-a84d-ff756b7330ab", "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}}/organizations/:id/merge", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id", "merge" ], "variable": [ { "id": "4bc51256-daa4-467d-aa2f-8bfbbbf5b1ad", "key": "id", "value": "", "description": "(Required) The ID of the organization" } ] }, "description": "Merges an organization with another organization. For more information, see the tutorial for merging two organizations." }, "response": [ { "id": "aca7add6-7f65-4292-9202-4b89e1671505", "name": "Success", "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}}/organizations/:id/merge", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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 }\n}", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-aca7add6-7f65-4292-9202-4b89e1671505" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-2f00d838-1534-47d9-a84d-ff756b7330ab" } ], "id": "4e804231-3444-4ed2-8e7b-215d475ac182", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-4e804231-3444-4ed2-8e7b-215d475ac182" }, { "name": "permittedUsers", "item": [ { "name": "List permitted users", "id": "55c10957-e269-47c9-a7b1-b43ef9f63e28", "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}}/organizations/:id/permittedUsers", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id", "permittedUsers" ], "variable": [ { "id": "af91e9e2-764a-4be9-b8a4-38e3e1f09cfd", "key": "id", "value": "", "description": "(Required) The ID of the organization" } ] }, "description": "List users permitted to access an organization." }, "response": [ { "id": "a97e902b-3555-4a58-83f3-1b394563317e", "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}}/organizations/:id/permittedUsers", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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 \"data\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-a97e902b-3555-4a58-83f3-1b394563317e" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-55c10957-e269-47c9-a7b1-b43ef9f63e28" } ], "id": "55b94013-c648-43bf-9ae8-a9a6dc6e92d3", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-55b94013-c648-43bf-9ae8-a9a6dc6e92d3" }, { "name": "Delete a organization", "id": "5a0bf7fd-8d9a-45da-acaf-5b93c0756247", "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}}/organizations/:id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id" ], "variable": [ { "id": "6cb2dcaf-2a6b-4ff5-8520-5000cf504260", "key": "id", "value": "", "description": "(Required) The ID of the organization" } ] }, "description": "Marks a organization as deleted. After 30 days, the organization will be permanently deleted." }, "response": [ { "id": "2bb917d5-fc70-4685-8a62-db5be8d93e97", "name": "Delete organization", "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}}/organizations/:id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-2bb917d5-fc70-4685-8a62-db5be8d93e97" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-5a0bf7fd-8d9a-45da-acaf-5b93c0756247" }, { "name": "Get details of a organization", "id": "386451c6-b999-4088-addd-746e7f77a219", "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}}/organizations/:id?include_fields=open_deals_count&custom_fields=&include_option_labels=&include_labels=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id" ], "query": [ { "description": "Optional comma separated string array of additional fields to include", "key": "include_fields", "value": "open_deals_count" }, { "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": "73264cc3-8912-4a3d-8f59-3907ac81eaa6", "key": "id", "value": "", "description": "(Required) The ID of the organization" } ] }, "description": "Returns the details of a specific organization." }, "response": [ { "id": "15d5a68c-1de7-4e02-8431-f5f9d41b187e", "name": "Get organization", "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}}/organizations/:id?include_fields=open_deals_count&custom_fields=&include_option_labels=&include_labels=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id" ], "query": [ { "description": "Optional comma separated string array of additional fields to include", "key": "include_fields", "value": "open_deals_count" }, { "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 \"name\": \"\",\n \"owner_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"is_deleted\": \"\",\n \"visible_to\": \"\",\n \"address\": {\n \"value\": \"\",\n \"country\": \"\",\n \"admin_area_level_1\": \"\",\n \"admin_area_level_2\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"route\": \"\",\n \"street_number\": \"\",\n \"subpremise\": \"\",\n \"postal_code\": \"\"\n },\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": {\n \"laborum0\": true,\n \"nostrudb5\": \"non incididunt labore\",\n \"elit_ec\": false\n }\n }\n}", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-15d5a68c-1de7-4e02-8431-f5f9d41b187e" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-386451c6-b999-4088-addd-746e7f77a219" }, { "name": "Update a organization", "id": "ee3fcd33-04bc-455d-ad54-60c5058fc301", "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 \"name\": \"\",\n \"owner_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"visible_to\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"address\": {\n \"value\": \"\",\n \"country\": \"\",\n \"admin_area_level_1\": \"\",\n \"admin_area_level_2\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"route\": \"\",\n \"street_number\": \"\",\n \"subpremise\": \"\",\n \"postal_code\": \"\"\n },\n \"custom_fields\": {\n \"commodod2_\": \"cupida\",\n \"tempor_c29\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations/:id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id" ], "variable": [ { "id": "24542af6-9f86-4b96-941e-7198ed7a560e", "key": "id", "value": "", "description": "(Required) The ID of the organization" } ] }, "description": "Updates the properties of a organization." }, "response": [ { "id": "acd2e742-7e62-487b-a7ea-ecc765fed991", "name": "Edit organization", "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 \"name\": \"\",\n \"owner_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"visible_to\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"address\": {\n \"value\": \"\",\n \"country\": \"\",\n \"admin_area_level_1\": \"\",\n \"admin_area_level_2\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"route\": \"\",\n \"street_number\": \"\",\n \"subpremise\": \"\",\n \"postal_code\": \"\"\n },\n \"custom_fields\": {\n \"commodod2_\": \"cupida\",\n \"tempor_c29\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations/:id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":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 \"name\": \"\",\n \"owner_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"is_deleted\": \"\",\n \"visible_to\": \"\",\n \"address\": {\n \"value\": \"\",\n \"country\": \"\",\n \"admin_area_level_1\": \"\",\n \"admin_area_level_2\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"route\": \"\",\n \"street_number\": \"\",\n \"subpremise\": \"\",\n \"postal_code\": \"\"\n },\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": {\n \"laborum0\": true,\n \"nostrudb5\": \"non incididunt labore\",\n \"elit_ec\": false\n }\n }\n}", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-acd2e742-7e62-487b-a7ea-ecc765fed991" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-ee3fcd33-04bc-455d-ad54-60c5058fc301" } ], "id": "0440e65b-36e0-48dd-a103-38e31e343452", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-0440e65b-36e0-48dd-a103-38e31e343452" }, { "name": "search", "item": [ { "name": "Search organizations", "id": "bb384bc3-6d2b-4200-a964-1e4219b197af", "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}}/organizations/search?term=&fields=custom_fields&exact_match=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", "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": "custom_fields" }, { "description": "When enabled, only full exact matches against the given term are returned. It is not case sensitive.", "key": "exact_match", "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": "Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope." }, "response": [ { "id": "f897a1bf-2592-41f3-af9c-a1fff81a0741", "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}}/organizations/search?term=&fields=custom_fields&exact_match=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", "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": "custom_fields" }, { "description": "When enabled, only full exact matches against the given term are returned. It is not case sensitive.", "key": "exact_match", "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 \"items\": [\n {\n \"result_score\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"address\": \"\",\n \"visible_to\": \"\",\n \"owner\": {\n \"id\": \"\"\n },\n \"custom_fields\": [\n \"\",\n \"\"\n ],\n \"notes\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"result_score\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"address\": \"\",\n \"visible_to\": \"\",\n \"owner\": {\n \"id\": \"\"\n },\n \"custom_fields\": [\n \"\",\n \"\"\n ],\n \"notes\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n },\n \"additional_data\": {\n \"next_cursor\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-f897a1bf-2592-41f3-af9c-a1fff81a0741" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-bb384bc3-6d2b-4200-a964-1e4219b197af" } ], "id": "1c99d2a7-ccd1-47d0-8014-9067f16e6b35", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-1c99d2a7-ccd1-47d0-8014-9067f16e6b35" }, { "name": "Get all organizations", "id": "6d9f5190-af1b-4cc3-af2d-523380de8c20", "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}}/organizations?filter_id=&ids=&owner_id=&updated_since=&updated_until=&sort_by=id&sort_direction=asc&include_fields=open_deals_count&custom_fields=&include_option_labels=&include_labels=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ], "query": [ { "description": "If supplied, only organizations 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 organizations owned by the specified user are returned. If filter_id is provided, this is ignored.", "key": "owner_id", "value": "" }, { "description": "If set, only organizations 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 organizations 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": "open_deals_count" }, { "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 organizations." }, "response": [ { "id": "bde54200-8870-4e37-bdb0-19eb3936a3ba", "name": "Get all organizations", "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}}/organizations?filter_id=&ids=&owner_id=&updated_since=&updated_until=&sort_by=id&sort_direction=asc&include_fields=open_deals_count&custom_fields=&include_option_labels=&include_labels=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ], "query": [ { "description": "If supplied, only organizations 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 organizations owned by the specified user are returned. If filter_id is provided, this is ignored.", "key": "owner_id", "value": "" }, { "description": "If set, only organizations 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 organizations 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": "open_deals_count" }, { "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 \"name\": \"\",\n \"owner_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"is_deleted\": \"\",\n \"visible_to\": \"\",\n \"address\": {\n \"value\": \"\",\n \"country\": \"\",\n \"admin_area_level_1\": \"\",\n \"admin_area_level_2\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"route\": \"\",\n \"street_number\": \"\",\n \"subpremise\": \"\",\n \"postal_code\": \"\"\n },\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": {\n \"in_11\": true,\n \"velit_4\": 39474302.53739205,\n \"voluptate6e1\": \"Duis sunt exerc\",\n \"elit_c_\": false\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"owner_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"is_deleted\": \"\",\n \"visible_to\": \"\",\n \"address\": {\n \"value\": \"\",\n \"country\": \"\",\n \"admin_area_level_1\": \"\",\n \"admin_area_level_2\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"route\": \"\",\n \"street_number\": \"\",\n \"subpremise\": \"\",\n \"postal_code\": \"\"\n },\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": {\n \"qui_79\": 63010850,\n \"nulla_9\": 21020161.027723864\n }\n }\n ],\n \"additional_data\": {\n \"next_cursor\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-bde54200-8870-4e37-bdb0-19eb3936a3ba" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-6d9f5190-af1b-4cc3-af2d-523380de8c20" }, { "name": "Add a new organization", "id": "f61ede42-7447-454e-8fde-faaca6adc4b5", "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 \"name\": \"\",\n \"owner_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"visible_to\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"address\": {\n \"value\": \"\",\n \"country\": \"\",\n \"admin_area_level_1\": \"\",\n \"admin_area_level_2\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"route\": \"\",\n \"street_number\": \"\",\n \"subpremise\": \"\",\n \"postal_code\": \"\"\n },\n \"custom_fields\": {\n \"veniam___\": \"aute\",\n \"laboris18\": \"Excepteur quis dolor eiusmod\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ] }, "description": "Adds a new organization." }, "response": [ { "id": "b799a041-b824-4d12-9181-2035f42531a8", "name": "Add organization", "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 \"name\": \"\",\n \"owner_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"visible_to\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"address\": {\n \"value\": \"\",\n \"country\": \"\",\n \"admin_area_level_1\": \"\",\n \"admin_area_level_2\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"route\": \"\",\n \"street_number\": \"\",\n \"subpremise\": \"\",\n \"postal_code\": \"\"\n },\n \"custom_fields\": {\n \"veniam___\": \"aute\",\n \"laboris18\": \"Excepteur quis dolor eiusmod\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ] } }, "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 \"name\": \"\",\n \"owner_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"is_deleted\": \"\",\n \"visible_to\": \"\",\n \"address\": {\n \"value\": \"\",\n \"country\": \"\",\n \"admin_area_level_1\": \"\",\n \"admin_area_level_2\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"route\": \"\",\n \"street_number\": \"\",\n \"subpremise\": \"\",\n \"postal_code\": \"\"\n },\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"custom_fields\": {\n \"laborum0\": true,\n \"nostrudb5\": \"non incididunt labore\",\n \"elit_ec\": false\n }\n }\n}", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-b799a041-b824-4d12-9181-2035f42531a8" } ], "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-f61ede42-7447-454e-8fde-faaca6adc4b5" } ], "id": "f7482a61-a888-4424-a6d6-06508fe632db", "createdAt": "2026-07-28T02:37:44.000Z", "updatedAt": "2026-07-28T02:37:44.000Z", "uid": "35240-f7482a61-a888-4424-a6d6-06508fe632db" } ], "variable": [ { "key": "baseUrl", "value": "https://api.pipedrive.com/v1" } ] }