{ "info": { "_postman_id": "cea67f07-e0cf-4978-a601-9fc680a026a1", "name": "Pipedrive API v1 Activities Persons 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:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "lastUpdatedBy": "35240", "uid": "35240-cea67f07-e0cf-4978-a601-9fc680a026a1" }, "item": [ { "name": "persons", "item": [ { "name": "{id}", "item": [ { "name": "changelog", "item": [ { "name": "List updates about person field values", "id": "7916b345-1fca-4ece-a061-ba4e1fb19458", "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}}/persons/:id/changelog?cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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": "20125bf4-9ad6-47ec-8eeb-46ce79b102a9", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Lists updates about field values of a person." }, "response": [ { "id": "e7b0a55f-5df9-4373-aa45-2b528f4ce1b0", "name": "Get changelog of a person", "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}}/persons/:id/changelog?cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-e7b0a55f-5df9-4373-aa45-2b528f4ce1b0" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-7916b345-1fca-4ece-a061-ba4e1fb19458" } ], "id": "f69868c6-ee98-4678-877d-8be342ab288e", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-f69868c6-ee98-4678-877d-8be342ab288e" }, { "name": "files", "item": [ { "name": "List files attached to a person", "id": "ada23251-fea5-4801-a33e-000fd49a1336", "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}}/persons/:id/files?start=0&limit=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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": "e8df6fab-4fed-4371-b640-fdba4da0f274", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Lists files associated with a person." }, "response": [ { "id": "e6ad6e64-c1f6-43af-83ef-2c8be7451195", "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}}/persons/:id/files?start=0&limit=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-e6ad6e64-c1f6-43af-83ef-2c8be7451195" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-ada23251-fea5-4801-a33e-000fd49a1336" } ], "id": "7d4cbf73-18ed-4e01-87af-7080cbb85f54", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-7d4cbf73-18ed-4e01-87af-7080cbb85f54" }, { "name": "flow", "item": [ { "name": "List updates about a person", "id": "3f5e9ae2-8d9a-4d38-9b1b-9b1ef50a2573", "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}}/persons/:id/flow?start=0&limit=&all_changes=&items=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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": "0117ed59-6a9d-45dd-9844-82aff3de42ca", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Lists updates about a person.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint's response will also include updates for the `marketing_status` field." }, "response": [ { "id": "2bed7902-e1b2-4cc7-a4c5-13a5e82376dc", "name": "Get the person 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}}/persons/:id/flow?start=0&limit=&all_changes=&items=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-2bed7902-e1b2-4cc7-a4c5-13a5e82376dc" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-3f5e9ae2-8d9a-4d38-9b1b-9b1ef50a2573" } ], "id": "8e4815da-e75a-48ff-bfc3-08a4e5a1db93", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-8e4815da-e75a-48ff-bfc3-08a4e5a1db93" }, { "name": "followers", "item": [ { "name": "{follower_id}", "item": [ { "name": "Delete a follower from a person", "id": "fca4e1b0-aec2-4f77-8e5f-a9410e869197", "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}}/persons/:id/followers/:follower_id", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "followers", ":follower_id" ], "variable": [ { "id": "eb94626c-d948-4cb7-a092-579433a2603d", "key": "id", "value": "", "description": "(Required) The ID of the person" }, { "id": "be2b709f-80fe-4f22-b209-68cceb52b7c1", "key": "follower_id", "value": "", "description": "(Required) The ID of the relationship between the follower and the person" } ] }, "description": "Deletes a follower from a person." }, "response": [ { "id": "59fb3c8e-bd77-4b17-8f1f-30391ef842cc", "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}}/persons/:id/followers/:follower_id", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-59fb3c8e-bd77-4b17-8f1f-30391ef842cc" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-fca4e1b0-aec2-4f77-8e5f-a9410e869197" } ], "id": "dee7cb9c-e0d3-42ee-9abb-b0db700df854", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-dee7cb9c-e0d3-42ee-9abb-b0db700df854" }, { "name": "changelog", "item": [ { "name": "List followers changelog of a person", "id": "507185af-a179-4bb6-be9b-7ce15864106c", "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}}/persons/:id/followers/changelog?limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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": "6d185953-a99b-4895-b904-5214c062236d", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Lists changelogs about users have followed the person." }, "response": [ { "id": "633c2af2-be32-4b3e-a8cd-d3605039f27e", "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}}/persons/:id/followers/changelog?limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-633c2af2-be32-4b3e-a8cd-d3605039f27e" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-507185af-a179-4bb6-be9b-7ce15864106c" } ], "id": "6fadeb6f-0af2-4317-a34a-5e538c4a7c75", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-6fadeb6f-0af2-4317-a34a-5e538c4a7c75" }, { "name": "List followers of a person", "id": "a9b4ed44-93e5-4d35-8e7b-f6a2f6c45ad0", "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}}/persons/:id/followers", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "followers" ], "variable": [ { "id": "5f2591e1-3a1b-4def-9d32-2c456f57404f", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Lists the followers of a person." }, "response": [ { "id": "b9f8159c-d00c-4b71-95cd-68bd954d469e", "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}}/persons/:id/followers", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-b9f8159c-d00c-4b71-95cd-68bd954d469e" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-a9b4ed44-93e5-4d35-8e7b-f6a2f6c45ad0" }, { "name": "Add a follower to a person", "id": "4439f33b-866a-4bd0-a600-ea5a5f356897", "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}}/persons/:id/followers", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "followers" ], "variable": [ { "id": "14869262-6cf7-434b-846f-7a1041aeda6f", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Adds a follower to a person." }, "response": [ { "id": "e0bce610-b134-48ba-a936-cdfe7493df67", "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}}/persons/:id/followers", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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 \"person_id\": \"\",\n \"add_time\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-e0bce610-b134-48ba-a936-cdfe7493df67" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-4439f33b-866a-4bd0-a600-ea5a5f356897" } ], "id": "5e24aabf-7282-4fdc-82f9-a30c90dc2e02", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-5e24aabf-7282-4fdc-82f9-a30c90dc2e02" }, { "name": "mailMessages", "item": [ { "name": "List mail messages associated with a person", "id": "a696675c-3d6b-491b-8c1f-ec934efe7c75", "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}}/persons/:id/mailMessages?start=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "mailMessages" ], "query": [ { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page", "key": "limit", "value": "" } ], "variable": [ { "id": "8befef57-fca6-409f-b7dc-e72a35d1f1d9", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Lists mail messages associated with a person." }, "response": [ { "id": "b70d45bf-48da-4a51-ba06-4a4dba2d0219", "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}}/persons/:id/mailMessages?start=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-b70d45bf-48da-4a51-ba06-4a4dba2d0219" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-a696675c-3d6b-491b-8c1f-ec934efe7c75" } ], "id": "d0547879-740a-4773-b876-13bb9986ebe4", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-d0547879-740a-4773-b876-13bb9986ebe4" }, { "name": "merge", "item": [ { "name": "Merge two persons", "id": "ae970f82-cdc0-4334-b3e2-6ff7b5e2eab7", "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}}/persons/:id/merge", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "merge" ], "variable": [ { "id": "071b2c6a-a3fd-4ec0-ab41-8bf41ec00860", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Merges a person with another person. For more information, see the tutorial for merging two persons." }, "response": [ { "id": "e0dd9b1c-4c53-4acc-b230-cb5e71c8eb4a", "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}}/persons/:id/merge", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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 \"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 \"org_id\": \"\",\n \"merge_what_id\": \"\",\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 \"participant_open_deals_count\": \"\",\n \"participant_closed_deals_count\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-e0dd9b1c-4c53-4acc-b230-cb5e71c8eb4a" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-ae970f82-cdc0-4334-b3e2-6ff7b5e2eab7" } ], "id": "5c6ec26a-d9d7-4382-8200-e2d1197a8593", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-5c6ec26a-d9d7-4382-8200-e2d1197a8593" }, { "name": "permittedUsers", "item": [ { "name": "List permitted users", "id": "fe168130-5345-4736-b285-786615fcd0e8", "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}}/persons/:id/permittedUsers", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "permittedUsers" ], "variable": [ { "id": "69101764-110d-4863-9728-3679216302f5", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "List users permitted to access a person." }, "response": [ { "id": "631188c9-3924-4805-9e02-38f6d22e361a", "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}}/persons/:id/permittedUsers", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-631188c9-3924-4805-9e02-38f6d22e361a" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-fe168130-5345-4736-b285-786615fcd0e8" } ], "id": "1246306d-d925-4307-92f4-5339cd418138", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-1246306d-d925-4307-92f4-5339cd418138" }, { "name": "picture", "item": [ { "name": "Delete person picture", "id": "b5adf88f-1996-493e-a8d8-7ce64b98dbff", "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}}/persons/:id/picture", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "picture" ], "variable": [ { "id": "1769833c-ebc4-47de-ab4b-50d061b9c0eb", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Deletes a person\u2019s picture." }, "response": [ { "id": "00f8ecdf-85dc-4cb4-8dbb-14b57692a57d", "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}}/persons/:id/picture", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "picture" ], "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:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-00f8ecdf-85dc-4cb4-8dbb-14b57692a57d" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-b5adf88f-1996-493e-a8d8-7ce64b98dbff" }, { "name": "Add person picture", "id": "c740fb84-2494-45ff-b6b3-ade5eab35270", "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": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) One image supplied in the multipart/form-data encoding", "key": "file", "type": "file", "value": null }, { "description": "X coordinate to where start cropping form (in pixels)", "key": "crop_x", "value": "", "type": "text" }, { "description": "Y coordinate to where start cropping form (in pixels)", "key": "crop_y", "value": "", "type": "text" }, { "description": "The width of the cropping area (in pixels)", "key": "crop_width", "value": "", "type": "text" }, { "description": "The height of the cropping area (in pixels)", "key": "crop_height", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/persons/:id/picture", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "picture" ], "variable": [ { "id": "35d3e042-cf74-458f-8deb-04ef6438637f", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Adds a picture to a person. If a picture is already set, the old picture will be replaced. Added image (or the cropping parameters supplied with the request) should have an equal width and height and should be at least 128 pixels. GIF, JPG and PNG are accepted. All added images will be resized to 128 and 512 pixel wide squares." }, "response": [ { "id": "7416ade5-9b07-491b-b0c0-fc8ab9cc6eda", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) One image supplied in the multipart/form-data encoding", "key": "file", "type": "file" }, { "description": "X coordinate to where start cropping form (in pixels)", "key": "crop_x", "value": "", "type": "text" }, { "description": "Y coordinate to where start cropping form (in pixels)", "key": "crop_y", "value": "", "type": "text" }, { "description": "The width of the cropping area (in pixels)", "key": "crop_width", "value": "", "type": "text" }, { "description": "The height of the cropping area (in pixels)", "key": "crop_height", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/persons/:id/picture", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "picture" ], "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 \"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 }\n}", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-7416ade5-9b07-491b-b0c0-fc8ab9cc6eda" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-c740fb84-2494-45ff-b6b3-ade5eab35270" }, { "name": "Get picture of a person", "id": "2464926c-ab7c-4e59-8871-1d2edb7248b2", "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}}/persons/:id/picture", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "picture" ], "variable": [ { "id": "a7bc7509-e131-4a78-bf4b-142149ce2d6c", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Returns the picture associated with a person. The picture URLs include both 128x128 and 512x512 pixel versions." }, "response": [ { "id": "179c633b-2701-4fe3-a854-5e0f3910dc52", "name": "Get person picture", "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}}/persons/:id/picture", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "picture" ], "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 \"item_type\": \"\",\n \"item_id\": \"\",\n \"added_by_user_id\": \"\",\n \"active_flag\": \"\",\n \"file_size\": \"\",\n \"pictures\": {\n \"128\": \"\",\n \"512\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-179c633b-2701-4fe3-a854-5e0f3910dc52" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-2464926c-ab7c-4e59-8871-1d2edb7248b2" } ], "id": "4b95ba3a-2f73-4bcf-a708-3dbbaeae2be7", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-4b95ba3a-2f73-4bcf-a708-3dbbaeae2be7" }, { "name": "products", "item": [ { "name": "List products associated with a person", "id": "c227ee7d-1ffd-46fc-83e8-e703ed7e15af", "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}}/persons/:id/products?start=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "products" ], "query": [ { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page", "key": "limit", "value": "" } ], "variable": [ { "id": "2e884939-91ac-4fc4-af7d-6a76009c2327", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Lists products associated with a person." }, "response": [ { "id": "5658a254-23db-45d8-bfab-90c509a36e61", "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}}/persons/:id/products?start=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id", "products" ], "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 \"DEAL_ID\": {\n \"deal\": {\n \"id\": \"\",\n \"company_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 \"first_add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"active\": \"\",\n \"deleted\": \"\",\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 },\n \"product\": {\n \"id\": \"\",\n \"company_id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"description\": \"\",\n \"unit\": \"\",\n \"tax\": 0,\n \"category\": \"\",\n \"active_flag\": true,\n \"selectable\": true,\n \"first_char\": \"\",\n \"visible_to\": \"7\",\n \"owner_id\": \"\",\n \"files_count\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"deal_id\": \"\"\n }\n }\n },\n {\n \"DEAL_ID\": {\n \"deal\": {\n \"id\": \"\",\n \"company_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 \"first_add_time\": \"\",\n \"update_time\": \"\",\n \"stage_change_time\": \"\",\n \"active\": \"\",\n \"deleted\": \"\",\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 },\n \"product\": {\n \"id\": \"\",\n \"company_id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"description\": \"\",\n \"unit\": \"\",\n \"tax\": 0,\n \"category\": \"\",\n \"active_flag\": true,\n \"selectable\": true,\n \"first_char\": \"\",\n \"visible_to\": \"5\",\n \"owner_id\": \"\",\n \"files_count\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"deal_id\": \"\"\n }\n }\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:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-5658a254-23db-45d8-bfab-90c509a36e61" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-c227ee7d-1ffd-46fc-83e8-e703ed7e15af" } ], "id": "9fd35aa8-24ba-4da8-8f49-e61c213380bd", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-9fd35aa8-24ba-4da8-8f49-e61c213380bd" }, { "name": "Delete a person", "id": "a0aba590-bf12-4fb9-81b9-29c47a0f0927", "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}}/persons/:id", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id" ], "variable": [ { "id": "19cc129c-abe8-4b2d-bfbf-f2d7f9b20cda", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Marks a person as deleted. After 30 days, the person will be permanently deleted." }, "response": [ { "id": "8f2716f0-1a1d-4174-aa4f-da03cbc46e20", "name": "Delete person", "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}}/persons/:id", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-8f2716f0-1a1d-4174-aa4f-da03cbc46e20" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-a0aba590-bf12-4fb9-81b9-29c47a0f0927" }, { "name": "Get details of a person", "id": "2a8fd267-4cd4-4be8-8da7-278ab7267fbc", "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}}/persons/:id?include_fields=activities_count&custom_fields=&include_option_labels=&include_labels=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id" ], "query": [ { "description": "Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.", "key": "include_fields", "value": "activities_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": "488e4933-1e8b-4b58-b19c-b8d29e3e92f7", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company." }, "response": [ { "id": "74427429-d439-4519-a58f-1db4d249a6c7", "name": "Get person", "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}}/persons/:id?include_fields=activities_count&custom_fields=&include_option_labels=&include_labels=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id" ], "query": [ { "description": "Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.", "key": "include_fields", "value": "activities_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 \"first_name\": \"\",\n \"last_name\": \"\",\n \"owner_id\": \"\",\n \"org_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"is_deleted\": \"\",\n \"visible_to\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"picture_id\": \"\",\n \"postal_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 \"notes\": \"\",\n \"im\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"job_title\": \"\",\n \"custom_fields\": {\n \"Excepteur_1\": -80452100,\n \"commodoaf5\": 35821222.60242051,\n \"proident_27\": \"fugiat\"\n }\n }\n}", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-74427429-d439-4519-a58f-1db4d249a6c7" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-2a8fd267-4cd4-4be8-8da7-278ab7267fbc" }, { "name": "Update a person", "id": "85bd6331-92e6-44d0-96fb-09c3c11a4c10", "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 \"org_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"visible_to\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"marketing_status\": \"subscribed\",\n \"custom_fields\": {\n \"enim_7\": \"Lorem qui anim\",\n \"enim_3b\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persons/:id", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":id" ], "variable": [ { "id": "f05636b1-ddfe-4210-b131-d90dd47c1314", "key": "id", "value": "", "description": "(Required) The ID of the person" } ] }, "description": "Updates the properties of a person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field." }, "response": [ { "id": "84719281-ea7d-4362-b92d-2c902a601c32", "name": "Edit person", "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 \"org_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"visible_to\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"marketing_status\": \"subscribed\",\n \"custom_fields\": {\n \"enim_7\": \"Lorem qui anim\",\n \"enim_3b\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persons/:id", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":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 \"first_name\": \"\",\n \"last_name\": \"\",\n \"owner_id\": \"\",\n \"org_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"is_deleted\": \"\",\n \"visible_to\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"picture_id\": \"\",\n \"postal_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 \"notes\": \"\",\n \"im\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"job_title\": \"\",\n \"custom_fields\": {\n \"Excepteur_1\": -80452100,\n \"commodoaf5\": 35821222.60242051,\n \"proident_27\": \"fugiat\"\n }\n }\n}", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-84719281-ea7d-4362-b92d-2c902a601c32" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-85bd6331-92e6-44d0-96fb-09c3c11a4c10" } ], "id": "2402631c-0b05-4c9e-9453-8cc3b7e92755", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-2402631c-0b05-4c9e-9453-8cc3b7e92755" }, { "name": "search", "item": [ { "name": "Search persons", "id": "fd03475e-0710-4847-84b7-96e9d585c726", "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}}/persons/search?term=&fields=email&exact_match=&organization_id=&include_fields=person.picture&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "persons", "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": "email" }, { "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 persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.", "key": "organization_id", "value": "" }, { "description": "Supports including optional fields in the results which are not provided by default", "key": "include_fields", "value": "person.picture" }, { "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 persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found persons can be filtered by organization ID." }, "response": [ { "id": "3d035565-119f-4aa1-a416-bc6e0974d240", "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}}/persons/search?term=&fields=email&exact_match=&organization_id=&include_fields=person.picture&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "persons", "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": "email" }, { "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 persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.", "key": "organization_id", "value": "" }, { "description": "Supports including optional fields in the results which are not provided by default", "key": "include_fields", "value": "person.picture" }, { "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 \"phones\": [\n \"\",\n \"\"\n ],\n \"emails\": [\n \"\",\n \"\"\n ],\n \"visible_to\": \"\",\n \"owner\": {\n \"id\": \"\"\n },\n \"organization\": {\n \"id\": \"\",\n \"name\": \"\"\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 \"phones\": [\n \"\",\n \"\"\n ],\n \"emails\": [\n \"\",\n \"\"\n ],\n \"visible_to\": \"\",\n \"owner\": {\n \"id\": \"\"\n },\n \"organization\": {\n \"id\": \"\",\n \"name\": \"\"\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:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-3d035565-119f-4aa1-a416-bc6e0974d240" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-fd03475e-0710-4847-84b7-96e9d585c726" } ], "id": "2bbcf45c-cfa7-45e0-97e4-fd707f832049", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-2bbcf45c-cfa7-45e0-97e4-fd707f832049" }, { "name": "Get all persons", "id": "8cc71a51-7408-4233-9264-7fb62d7b137e", "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}}/persons?filter_id=&ids=&owner_id=&org_id=&deal_id=&updated_since=&updated_until=&sort_by=id&sort_direction=asc&include_fields=activities_count&custom_fields=&include_option_labels=&include_labels=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "persons" ], "query": [ { "description": "If supplied, only persons 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 persons owned by the specified user are returned. If filter_id is provided, this is ignored.", "key": "owner_id", "value": "" }, { "description": "If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.", "key": "org_id", "value": "" }, { "description": "If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.", "key": "deal_id", "value": "" }, { "description": "If set, only persons 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 persons 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. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.", "key": "include_fields", "value": "activities_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 persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company." }, "response": [ { "id": "5665aad8-eb38-4d0e-a9b6-10c2b2057561", "name": "Get all persons", "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}}/persons?filter_id=&ids=&owner_id=&org_id=&deal_id=&updated_since=&updated_until=&sort_by=id&sort_direction=asc&include_fields=activities_count&custom_fields=&include_option_labels=&include_labels=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "persons" ], "query": [ { "description": "If supplied, only persons 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 persons owned by the specified user are returned. If filter_id is provided, this is ignored.", "key": "owner_id", "value": "" }, { "description": "If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.", "key": "org_id", "value": "" }, { "description": "If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.", "key": "deal_id", "value": "" }, { "description": "If set, only persons 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 persons 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. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.", "key": "include_fields", "value": "activities_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 \"first_name\": \"\",\n \"last_name\": \"\",\n \"owner_id\": \"\",\n \"org_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"is_deleted\": \"\",\n \"visible_to\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"picture_id\": \"\",\n \"postal_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 \"notes\": \"\",\n \"im\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"job_title\": \"\",\n \"custom_fields\": {\n \"Excepteur__\": 62335171,\n \"cillum_9d\": 67957440,\n \"incididuntc\": -10436205.954842806,\n \"in9c\": 82018057.54262462\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"owner_id\": \"\",\n \"org_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"is_deleted\": \"\",\n \"visible_to\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"picture_id\": \"\",\n \"postal_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 \"notes\": \"\",\n \"im\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"job_title\": \"\",\n \"custom_fields\": {\n \"esse_c61\": -13838254,\n \"laboris846\": 13467635,\n \"commodo_9\": false\n }\n }\n ],\n \"additional_data\": {\n \"next_cursor\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-5665aad8-eb38-4d0e-a9b6-10c2b2057561" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-8cc71a51-7408-4233-9264-7fb62d7b137e" }, { "name": "Add a new person", "id": "9592bc83-8889-4915-9c7c-b27f0cf9423d", "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 \"org_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"visible_to\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"marketing_status\": \"subscribed\",\n \"custom_fields\": {\n \"enim_7\": \"Lorem qui anim\",\n \"enim_3b\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persons", "host": [ "{{baseUrl}}" ], "path": [ "persons" ] }, "description": "Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field." }, "response": [ { "id": "7581137b-76a2-49ca-9f48-74a6acbad200", "name": "Add person", "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 \"org_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"visible_to\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"marketing_status\": \"subscribed\",\n \"custom_fields\": {\n \"enim_7\": \"Lorem qui anim\",\n \"enim_3b\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persons", "host": [ "{{baseUrl}}" ], "path": [ "persons" ] } }, "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 \"first_name\": \"\",\n \"last_name\": \"\",\n \"owner_id\": \"\",\n \"org_id\": \"\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"is_deleted\": \"\",\n \"visible_to\": \"\",\n \"label_ids\": [\n \"\",\n \"\"\n ],\n \"picture_id\": \"\",\n \"postal_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 \"notes\": \"\",\n \"im\": [\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n },\n {\n \"value\": \"\",\n \"primary\": \"\",\n \"label\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"job_title\": \"\",\n \"custom_fields\": {\n \"Excepteur_1\": -80452100,\n \"commodoaf5\": 35821222.60242051,\n \"proident_27\": \"fugiat\"\n }\n }\n}", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-7581137b-76a2-49ca-9f48-74a6acbad200" } ], "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-9592bc83-8889-4915-9c7c-b27f0cf9423d" } ], "id": "b5ccfcc5-bce4-4111-99f3-e9175b0629d5", "createdAt": "2026-07-28T02:37:48.000Z", "updatedAt": "2026-07-28T02:37:48.000Z", "uid": "35240-b5ccfcc5-bce4-4111-99f3-e9175b0629d5" } ], "variable": [ { "key": "baseUrl", "value": "https://api.pipedrive.com/v1" } ] }