{
"opencollection": "1.0.0",
"info": {
"name": "Pipedrive API v1 Activities Leads API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Leads",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all leads",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/leads",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "For pagination, the position that represents the first result for the page"
},
{
"name": "owner_id",
"value": "",
"type": "query",
"description": "If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied."
},
{
"name": "person_id",
"value": "",
"type": "query",
"description": "If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied."
},
{
"name": "organization_id",
"value": "",
"type": "query",
"description": "If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied."
},
{
"name": "filter_id",
"value": "",
"type": "query",
"description": "The ID of the filter to use"
},
{
"name": "updated_since",
"value": "",
"type": "query",
"description": "If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys)."
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the c"
},
{
"info": {
"name": "Add a lead",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pipedrive.com/v1/leads",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Creates a lead. A lead always has to be linked to a person or an organization or both. All leads created through the Pipedrive API will have a lead source and origin set to `API`. Here's the tutorial for adding a lead. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set "
},
{
"info": {
"name": "Get all archived leads",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/leads/archived",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "For pagination, the position that represents the first result for the page"
},
{
"name": "owner_id",
"value": "",
"type": "query",
"description": "If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied."
},
{
"name": "person_id",
"value": "",
"type": "query",
"description": "If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied."
},
{
"name": "organization_id",
"value": "",
"type": "query",
"description": "If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied."
},
{
"name": "filter_id",
"value": "",
"type": "query",
"description": "The ID of the filter to use"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys)."
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custo"
},
{
"info": {
"name": "Get one lead",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/leads/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the lead"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns details of a specific lead. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals."
},
{
"info": {
"name": "Update a lead",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.pipedrive.com/v1/leads/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the lead"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, inst"
},
{
"info": {
"name": "Delete a lead",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pipedrive.com/v1/leads/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the lead"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Deletes a specific lead."
},
{
"info": {
"name": "List permitted users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/leads/:id/permittedUsers",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the lead"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Lists the users permitted to access a lead."
},
{
"info": {
"name": "Search leads",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/leads/search",
"params": [
{
"name": "term",
"value": "",
"type": "query",
"description": "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."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma-separated string array. The fields to perform the search from. Defaults to all of them."
},
{
"name": "exact_match",
"value": "",
"type": "query",
"description": "When enabled, only full exact matches against the given term are returned. It is not case sensitive."
},
{
"name": "person_id",
"value": "",
"type": "query",
"description": "Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000."
},
{
"name": "organization_id",
"value": "",
"type": "query",
"description": "Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Supports including optional fields in the results which are not provided by default"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Items shown per page"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID."
},
{
"info": {
"name": "Convert a lead to a deal",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pipedrive.com/v1/leads/:id/convert/deal",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the lead to convert"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the /api/v2/leads/{lead_id}/convert/stat"
},
{
"info": {
"name": "Get Lead conversion status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/leads/:id/convert/status/:conversion_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of a lead"
},
{
"name": "conversion_id",
"value": "",
"type": "path",
"description": "The ID of the conversion"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days."
}
]
}
],
"bundled": true
}