FilesGetAllFilesResponse
{
"type": "object",
"title": "getFilesResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the file"
},
"cid": {
"type": "string",
"description": "The ID of the inline attachment"
},
"url": {
"type": "string",
"description": "The URL of the download file"
},
"name": {
"type": "string",
"description": "The visible name of the file"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization to associate the file with"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal to associate the file with"
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead to associate the file with"
},
"user_id": {
"type": "integer",
"description": "The ID of the user to associate the file with"
},
"add_time": {
"type": "string",
"description": "The date and time when the file was added/created. Format: YYYY-MM-DD HH:MM:SS"
},
"org_name": {
"type": "string",
"description": "The name of the organization associated with the file"
},
"deal_name": {
"type": "string",
"description": "The name of the deal associated with the file"
},
"file_name": {
"type": "string",
"description": "The original name of the file"
},
"file_size": {
"type": "integer",
"description": "The size of the file"
},
"lead_name": {
"type": "string",
"description": "The name of the lead associated with the file"
},
"person_id": {
"type": "integer",
"description": "The ID of the person to associate the file with"
},
"remote_id": {
"type": "string",
"description": "The ID of the remote item"
},
"s3_bucket": {
"type": "string",
"description": "The location of the cloud storage"
},
"product_id": {
"type": "integer",
"description": "The ID of the product to associate the file with"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not. false = Not activated, true = Activated"
},
"activity_id": {
"type": "integer",
"description": "The ID of the activity to associate the file with"
},
"description": {
"type": "string",
"description": "The description of the file"
},
"inline_flag": {
"type": "boolean",
"description": "Whether the file was uploaded as inline or not"
},
"person_name": {
"type": "string",
"description": "The name of the person associated with the file"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the file. Format: YYYY-MM-DD HH:MM:SS"
},
"product_name": {
"type": "string",
"description": "The name of the product associated with the file"
},
"mail_message_id": {
"type": "string",
"description": "The ID of the mail message to associate the file with"
},
"remote_location": {
"type": "string",
"description": "The location type to send the file to. Only googledrive is supported at the moment."
},
"mail_template_id": {
"type": "string",
"description": "The ID of the mail template to associate the file with"
}
},
"description": "The file data"
},
"description": "The array of all uploaded files"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
},
"additional_data": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Items shown per page"
},
"start": {
"type": "integer",
"description": "Pagination start"
},
"more_items_in_collection": {
"type": "boolean",
"description": "If there are more list items in the collection than displayed or not"
}
},
"description": "The additional data of the list"
},
{
"type": "object",
"properties": {
"next_start": {
"type": "integer",
"description": "Next pagination start"
}
}
}
],
"title": "paginationDetails",
"description": "Pagination details of the list"
}
}
}
}
}
FilesGetOneFileResponse
{
"type": "object",
"title": "getFileResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the file"
},
"cid": {
"type": "string",
"description": "The ID of the inline attachment"
},
"url": {
"type": "string",
"description": "The URL of the download file"
},
"name": {
"type": "string",
"description": "The visible name of the file"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization to associate the file with"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal to associate the file with"
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead to associate the file with"
},
"user_id": {
"type": "integer",
"description": "The ID of the user to associate the file with"
},
"add_time": {
"type": "string",
"description": "The date and time when the file was added/created. Format: YYYY-MM-DD HH:MM:SS"
},
"org_name": {
"type": "string",
"description": "The name of the organization associated with the file"
},
"deal_name": {
"type": "string",
"description": "The name of the deal associated with the file"
},
"file_name": {
"type": "string",
"description": "The original name of the file"
},
"file_size": {
"type": "integer",
"description": "The size of the file"
},
"lead_name": {
"type": "string",
"description": "The name of the lead associated with the file"
},
"person_id": {
"type": "integer",
"description": "The ID of the person to associate the file with"
},
"remote_id": {
"type": "string",
"description": "The ID of the remote item"
},
"s3_bucket": {
"type": "string",
"description": "The location of the cloud storage"
},
"product_id": {
"type": "integer",
"description": "The ID of the product to associate the file with"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not. false = Not activated, true = Activated"
},
"activity_id": {
"type": "integer",
"description": "The ID of the activity to associate the file with"
},
"description": {
"type": "string",
"description": "The description of the file"
},
"inline_flag": {
"type": "boolean",
"description": "Whether the file was uploaded as inline or not"
},
"person_name": {
"type": "string",
"description": "The name of the person associated with the file"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the file. Format: YYYY-MM-DD HH:MM:SS"
},
"product_name": {
"type": "string",
"description": "The name of the product associated with the file"
},
"mail_message_id": {
"type": "string",
"description": "The ID of the mail message to associate the file with"
},
"remote_location": {
"type": "string",
"description": "The location type to send the file to. Only googledrive is supported at the moment."
},
"mail_template_id": {
"type": "string",
"description": "The ID of the mail template to associate the file with"
}
},
"description": "The file data"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
FilesLinkRemoteFileRequest
{
"type": "object",
"title": "linkFileToItemRequest",
"required": [
"item_type",
"item_id",
"remote_id",
"remote_location"
],
"properties": {
"item_id": {
"type": "integer",
"description": "The ID of the item to associate the file with"
},
"item_type": {
"enum": [
"deal",
"organization",
"person"
],
"type": "string",
"description": "The item type"
},
"remote_id": {
"type": "string",
"description": "The remote item ID"
},
"remote_location": {
"enum": [
"googledrive"
],
"type": "string",
"description": "The location type to send the file to. Only `googledrive` is supported at the moment."
}
}
}
FilesLinkRemoteFileResponse
{
"type": "object",
"title": "linkFileToItemResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the file"
},
"cid": {
"type": "string",
"description": "The ID of the inline attachment"
},
"url": {
"type": "string",
"description": "The URL of the download file"
},
"name": {
"type": "string",
"description": "The visible name of the file"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization to associate the file with"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal to associate the file with"
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead to associate the file with"
},
"user_id": {
"type": "integer",
"description": "The ID of the user to associate the file with"
},
"add_time": {
"type": "string",
"description": "The date and time when the file was added/created. Format: YYYY-MM-DD HH:MM:SS"
},
"org_name": {
"type": "string",
"description": "The name of the organization associated with the file"
},
"deal_name": {
"type": "string",
"description": "The name of the deal associated with the file"
},
"file_name": {
"type": "string",
"description": "The original name of the file"
},
"file_size": {
"type": "integer",
"description": "The size of the file"
},
"lead_name": {
"type": "string",
"description": "The name of the lead associated with the file"
},
"person_id": {
"type": "integer",
"description": "The ID of the person to associate the file with"
},
"remote_id": {
"type": "string",
"description": "The ID of the remote item"
},
"s3_bucket": {
"type": "string",
"description": "The location of the cloud storage"
},
"product_id": {
"type": "integer",
"description": "The ID of the product to associate the file with"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not. false = Not activated, true = Activated"
},
"activity_id": {
"type": "integer",
"description": "The ID of the activity to associate the file with"
},
"description": {
"type": "string",
"description": "The description of the file"
},
"inline_flag": {
"type": "boolean",
"description": "Whether the file was uploaded as inline or not"
},
"person_name": {
"type": "string",
"description": "The name of the person associated with the file"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the file. Format: YYYY-MM-DD HH:MM:SS"
},
"product_name": {
"type": "string",
"description": "The name of the product associated with the file"
},
"mail_message_id": {
"type": "string",
"description": "The ID of the mail message to associate the file with"
},
"remote_location": {
"type": "string",
"description": "The location type to send the file to. Only googledrive is supported at the moment."
},
"mail_template_id": {
"type": "string",
"description": "The ID of the mail template to associate the file with"
}
},
"description": "The file data"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
FilesMarkAsDeletedResponse
{
"type": "object",
"title": "deleteFileResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the file"
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
FilesUpdateDetailsRequest
{
"type": "object",
"title": "updateFileRequest",
"properties": {
"name": {
"type": "string",
"description": "The visible name of the file"
},
"description": {
"type": "string",
"description": "The description of the file"
}
}
}
FilesUpdateDetailsResponse
{
"type": "object",
"title": "updateFileResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the file"
},
"cid": {
"type": "string",
"description": "The ID of the inline attachment"
},
"url": {
"type": "string",
"description": "The URL of the download file"
},
"name": {
"type": "string",
"description": "The visible name of the file"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization to associate the file with"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal to associate the file with"
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead to associate the file with"
},
"user_id": {
"type": "integer",
"description": "The ID of the user to associate the file with"
},
"add_time": {
"type": "string",
"description": "The date and time when the file was added/created. Format: YYYY-MM-DD HH:MM:SS"
},
"org_name": {
"type": "string",
"description": "The name of the organization associated with the file"
},
"deal_name": {
"type": "string",
"description": "The name of the deal associated with the file"
},
"file_name": {
"type": "string",
"description": "The original name of the file"
},
"file_size": {
"type": "integer",
"description": "The size of the file"
},
"lead_name": {
"type": "string",
"description": "The name of the lead associated with the file"
},
"person_id": {
"type": "integer",
"description": "The ID of the person to associate the file with"
},
"remote_id": {
"type": "string",
"description": "The ID of the remote item"
},
"s3_bucket": {
"type": "string",
"description": "The location of the cloud storage"
},
"product_id": {
"type": "integer",
"description": "The ID of the product to associate the file with"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not. false = Not activated, true = Activated"
},
"activity_id": {
"type": "integer",
"description": "The ID of the activity to associate the file with"
},
"description": {
"type": "string",
"description": "The description of the file"
},
"inline_flag": {
"type": "boolean",
"description": "Whether the file was uploaded as inline or not"
},
"person_name": {
"type": "string",
"description": "The name of the person associated with the file"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the file. Format: YYYY-MM-DD HH:MM:SS"
},
"product_name": {
"type": "string",
"description": "The name of the product associated with the file"
},
"mail_message_id": {
"type": "string",
"description": "The ID of the mail message to associate the file with"
},
"remote_location": {
"type": "string",
"description": "The location type to send the file to. Only googledrive is supported at the moment."
},
"mail_template_id": {
"type": "string",
"description": "The ID of the mail template to associate the file with"
}
},
"description": "The file data"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
FilesUploadAndAssociateRequest
{
"type": "object",
"title": "addFileRequest",
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "A single file, supplied in the multipart/form-data encoding and contained within the given boundaries"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization to associate file(s) with"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal to associate file(s) with"
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead to associate file(s) with"
},
"person_id": {
"type": "integer",
"description": "The ID of the person to associate file(s) with"
},
"product_id": {
"type": "integer",
"description": "The ID of the product to associate file(s) with"
},
"activity_id": {
"type": "integer",
"description": "The ID of the activity to associate file(s) with"
}
}
}
FilesUploadAndAssociateResponse
{
"type": "object",
"title": "addFileResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the file"
},
"cid": {
"type": "string",
"description": "The ID of the inline attachment"
},
"url": {
"type": "string",
"description": "The URL of the download file"
},
"name": {
"type": "string",
"description": "The visible name of the file"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization to associate the file with"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal to associate the file with"
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead to associate the file with"
},
"user_id": {
"type": "integer",
"description": "The ID of the user to associate the file with"
},
"add_time": {
"type": "string",
"description": "The date and time when the file was added/created. Format: YYYY-MM-DD HH:MM:SS"
},
"org_name": {
"type": "string",
"description": "The name of the organization associated with the file"
},
"deal_name": {
"type": "string",
"description": "The name of the deal associated with the file"
},
"file_name": {
"type": "string",
"description": "The original name of the file"
},
"file_size": {
"type": "integer",
"description": "The size of the file"
},
"lead_name": {
"type": "string",
"description": "The name of the lead associated with the file"
},
"person_id": {
"type": "integer",
"description": "The ID of the person to associate the file with"
},
"remote_id": {
"type": "string",
"description": "The ID of the remote item"
},
"s3_bucket": {
"type": "string",
"description": "The location of the cloud storage"
},
"product_id": {
"type": "integer",
"description": "The ID of the product to associate the file with"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not. false = Not activated, true = Activated"
},
"activity_id": {
"type": "integer",
"description": "The ID of the activity to associate the file with"
},
"description": {
"type": "string",
"description": "The description of the file"
},
"inline_flag": {
"type": "boolean",
"description": "Whether the file was uploaded as inline or not"
},
"person_name": {
"type": "string",
"description": "The name of the person associated with the file"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the file. Format: YYYY-MM-DD HH:MM:SS"
},
"product_name": {
"type": "string",
"description": "The name of the product associated with the file"
},
"mail_message_id": {
"type": "string",
"description": "The ID of the mail message to associate the file with"
},
"remote_location": {
"type": "string",
"description": "The location type to send the file to. Only googledrive is supported at the moment."
},
"mail_template_id": {
"type": "string",
"description": "The ID of the mail template to associate the file with"
}
},
"description": "The file data"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
FiltersAddNewFilterRequest
{
"type": "object",
"title": "addFilterRequest",
"required": [
"name",
"conditions",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the filter"
},
"type": {
"type": "string",
"allOf": [
{
"enum": [
"deals",
"leads",
"org",
"people",
"products",
"activity",
"projects"
],
"type": "string"
}
],
"description": "The type of filter to create"
},
"conditions": {
"type": "object",
"description": "The conditions of the filter as a JSON object. Please note that a maximum of 16 conditions is allowed per filter and `date` values must be supplied in the `YYYY-MM-DD` format. It requires a minimum structure as follows: `{\"glue\":\"and\",\"conditions\":[{\"glue\":\"and\",\"conditions\": [CONDITION_OBJECTS]},{\"glue\":\"or\",\"conditions\":[CONDITION_OBJECTS]}]}`. Replace `CONDITION_OBJECTS` with JSON objects of the following structure: `{\"object\":\"\",\"field_id\":\"\", \"operator\":\"\",\"value\":\"\", \"extra_value\":\"\"}` or leave the array empty. Depending on the object type you should use another API endpoint to get `field_id`. There are five types of objects you can choose from: `\"person\"`, `\"deal\"`, `\"organization\"`, `\"product\"`, `\"activity\"` and you can use these types of operators depending on what type of a field you have: `\"IS NOT NULL\"`, `\"IS NULL\"`, `\"<=\"`, `\">=\"`, `\"<\"`, `\">\"`, `\"!=\"`, `\"=\"`, `\"LIKE '$%'\"`, `\"LIKE '%$%'\"`, `\"NOT LIKE '$%'\"`. To get a better understanding of how filters work try creating them directly from the Pipedrive application."
}
}
}
FiltersAddNewFilterResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the created filter"
},
"name": {
"type": "string",
"description": "The name of the created filter"
},
"type": {
"enum": [
"deals",
"leads",
"org",
"people",
"products",
"activity",
"projects"
],
"type": "string"
},
"user_id": {
"type": "integer",
"description": "The user ID of the created filter"
},
"add_time": {
"type": "string",
"description": "The add time of the created filter"
},
"conditions": {
"type": "object",
"description": "The created filter conditions object"
},
"visible_to": {
"type": "integer",
"description": "The visibility group ID of the created filter"
},
"active_flag": {
"type": "boolean",
"description": "The activity flag of the created filter"
},
"update_time": {
"type": "string",
"description": "The update time of the created filter"
},
"custom_view_id": {
"type": "integer",
"description": "The custom view ID of the created filter"
},
"temporary_flag": {
"type": "boolean",
"description": "If the created filter is temporary or not"
}
}
}
}
}
],
"title": "postFilterResponse200"
}
FiltersDeleteBulkResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The array of the IDs of the deleted filter"
}
}
}
}
}
],
"title": "deleteFiltersResponse200"
}
FiltersGetAllResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the filter"
},
"name": {
"type": "string",
"description": "The name of the filter"
},
"type": {
"type": "string",
"description": "The type of the item"
},
"user_id": {
"type": "integer",
"description": "The owner of the filter"
},
"add_time": {
"type": "string",
"description": "The date and time when the filter was added"
},
"visible_to": {
"type": "integer",
"description": "The visibility group ID of who can see then filter"
},
"active_flag": {
"type": "boolean",
"description": "The active flag of the filter"
},
"update_time": {
"type": "string",
"description": "The date and time when the filter was updated"
},
"custom_view_id": {
"type": "integer",
"description": "Used by Pipedrive webapp"
}
},
"description": "The filter object"
},
"description": "The array of filters"
}
}
}
],
"title": "getFiltersResponse200"
}
FiltersGetDetailsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the filter"
},
"name": {
"type": "string",
"description": "The name of the filter"
},
"type": {
"type": "string",
"description": "The type of the item"
},
"user_id": {
"type": "integer",
"description": "The owner of the filter"
},
"add_time": {
"type": "string",
"description": "The date and time when the filter was added"
},
"visible_to": {
"type": "integer",
"description": "The visibility group ID of who can see then filter"
},
"active_flag": {
"type": "boolean",
"description": "The active flag of the filter"
},
"update_time": {
"type": "string",
"description": "The date and time when the filter was updated"
},
"custom_view_id": {
"type": "integer",
"description": "Used by Pipedrive webapp"
}
},
"description": "The filter object"
}
}
}
],
"title": "getFilterResponse200"
}
FiltersGetHelpersResponse
{
"type": "object",
"title": "getFilterHelpersResponse200",
"description": "The rules for filters"
}
FiltersMarkAsDeletedResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deleted filter"
}
}
}
}
}
],
"title": "deleteFilterResponse200"
}
FiltersUpdateFilterRequest
{
"type": "object",
"title": "updateFilterRequest",
"required": [
"conditions"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the filter"
},
"conditions": {
"type": "object",
"description": "The conditions of the filter as a JSON object. Please note that a maximum of 16 conditions is allowed per filter and `date` values must be supplied in the `YYYY-MM-DD` format. It requires a minimum structure as follows: `{\"glue\":\"and\",\"conditions\":[{\"glue\":\"and\",\"conditions\": [CONDITION_OBJECTS]},{\"glue\":\"or\",\"conditions\":[CONDITION_OBJECTS]}]}`. Replace `CONDITION_OBJECTS` with JSON objects of the following structure: `{\"object\":\"\",\"field_id\":\"\", \"operator\":\"\",\"value\":\"\", \"extra_value\":\"\"}` or leave the array empty. Depending on the object type you should use another API endpoint to get `field_id`. There are five types of objects you can choose from: `\"person\"`, `\"deal\"`, `\"organization\"`, `\"product\"`, `\"activity\"` and you can use these types of operators depending on what type of a field you have: `\"IS NOT NULL\"`, `\"IS NULL\"`, `\"<=\"`, `\">=\"`, `\"<\"`, `\">\"`, `\"!=\"`, `\"=\"`, `\"LIKE '$%'\"`, `\"LIKE '%$%'\"`, `\"NOT LIKE '$%'\"`. To get a better understanding of how filters work try creating them directly from the Pipedrive application."
}
}
}
FiltersUpdateFilterResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the created filter"
},
"name": {
"type": "string",
"description": "The name of the created filter"
},
"type": {
"enum": [
"deals",
"leads",
"org",
"people",
"products",
"activity",
"projects"
],
"type": "string"
},
"user_id": {
"type": "integer",
"description": "The user ID of the created filter"
},
"add_time": {
"type": "string",
"description": "The add time of the created filter"
},
"conditions": {
"type": "object",
"description": "The created filter conditions object"
},
"visible_to": {
"type": "integer",
"description": "The visibility group ID of the created filter"
},
"active_flag": {
"type": "boolean",
"description": "The activity flag of the created filter"
},
"update_time": {
"type": "string",
"description": "The update time of the created filter"
},
"custom_view_id": {
"type": "integer",
"description": "The custom view ID of the created filter"
},
"temporary_flag": {
"type": "boolean",
"description": "If the created filter is temporary or not"
}
}
}
}
}
],
"title": "postFilterResponse200"
}
GoalsCreateReportRequest
{
"type": "object",
"title": "addGoalRequest",
"required": [
"type",
"assignee",
"expected_outcome",
"duration",
"interval"
],
"properties": {
"type": {
"type": "object",
"description": "The type of the goal. It requires the following JSON structure: `{ \"name\": \"deals_started\", \"params\": { \"pipeline_id\": [1, 2], \"activity_type_id\": [9] } }`. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. The `pipeline_id` and `activity_type_id` need to be given as an array of integers. To track the goal in all pipelines, set `pipeline_id` as `null` and similarly, to track the goal for all activities, set `activity_type_id` as `null`.”"
},
"title": {
"type": "string",
"description": "The title of the goal"
},
"assignee": {
"type": "object",
"description": "Who this goal is assigned to. It requires the following JSON structure: `{ \"id\": \"1\", \"type\": \"person\" }`. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team."
},
"duration": {
"type": "object",
"description": "The date when the goal starts and ends. It requires the following JSON structure: `{ \"start\": \"2019-01-01\", \"end\": \"2022-12-31\" }`. Date in format of YYYY-MM-DD. \"end\" can be set to `null` for an infinite, open-ended goal."
},
"interval": {
"enum": [
"weekly",
"monthly",
"quarterly",
"yearly"
],
"type": "string",
"description": "The interval of the goal"
},
"expected_outcome": {
"type": "object",
"description": "The expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: `{ \"target\": \"50\", \"tracking_metric\": \"quantity\" }` or `{ \"target\": \"50\", \"tracking_metric\": \"sum\", \"currency_id\": 1 }`. `currency_id` should only be added to `sum` type of goals."
}
}
}
GoalsCreateReportResponse
{
"type": "object",
"title": "addOrUpdateGoalResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"goal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the goal"
},
"type": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the goal type"
},
"params": {
"type": "object",
"properties": {
"pipeline_id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of pipelines of the goal"
},
"activity_type_id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of activity types of the goal"
}
},
"description": "The parameters that accompany the goal type"
}
},
"description": "The type of the goal"
},
"title": {
"type": "string",
"description": "The title of the goal"
},
"assignee": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the goal assignee"
},
"type": {
"type": "string",
"description": "The type of the assignee"
}
},
"description": "Who the goal is assigned to"
},
"duration": {
"type": "object",
"properties": {
"end": {
"type": "string",
"description": "The end date of the goal"
},
"start": {
"type": "string",
"description": "The start date of the goal"
}
},
"description": "The duration of the goal"
},
"interval": {
"type": "string",
"description": "The interval of the goal"
},
"owner_id": {
"type": "integer",
"description": "The ID of the creator of the goal"
},
"is_active": {
"type": "boolean",
"description": "Whether the goal is currently active or not"
},
"report_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the reports that belong to the goal"
},
"expected_outcome": {
"type": "object",
"properties": {
"target": {
"type": "integer",
"description": "The numeric target of the goal"
},
"tracking_metric": {
"type": "string",
"description": "The tracking metric of the goal"
}
},
"description": "The expected outcome of the goal"
}
}
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
GoalsGetByCriteriaResponse
{
"type": "object",
"title": "getGoalsResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"goals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the goal"
},
"type": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the goal type"
},
"params": {
"type": "object",
"properties": {
"pipeline_id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of pipelines of the goal"
},
"activity_type_id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of activity types of the goal"
}
},
"description": "The parameters that accompany the goal type"
}
},
"description": "The type of the goal"
},
"title": {
"type": "string",
"description": "The title of the goal"
},
"assignee": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the goal assignee"
},
"type": {
"type": "string",
"description": "The type of the assignee"
}
},
"description": "Who the goal is assigned to"
},
"duration": {
"type": "object",
"properties": {
"end": {
"type": "string",
"description": "The end date of the goal"
},
"start": {
"type": "string",
"description": "The start date of the goal"
}
},
"description": "The duration of the goal"
},
"interval": {
"type": "string",
"description": "The interval of the goal"
},
"owner_id": {
"type": "integer",
"description": "The ID of the creator of the goal"
},
"is_active": {
"type": "boolean",
"description": "Whether the goal is currently active or not"
},
"report_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the reports that belong to the goal"
},
"expected_outcome": {
"type": "object",
"properties": {
"target": {
"type": "integer",
"description": "The numeric target of the goal"
},
"tracking_metric": {
"type": "string",
"description": "The tracking metric of the goal"
}
},
"description": "The expected outcome of the goal"
}
}
}
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
GoalsGetResultResponse
{
"type": "object",
"title": "getGoalResultResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"goal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the goal"
},
"type": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the goal type"
},
"params": {
"type": "object",
"properties": {
"pipeline_id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of pipelines of the goal"
},
"activity_type_id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of activity types of the goal"
}
},
"description": "The parameters that accompany the goal type"
}
},
"description": "The type of the goal"
},
"title": {
"type": "string",
"description": "The title of the goal"
},
"assignee": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the goal assignee"
},
"type": {
"type": "string",
"description": "The type of the assignee"
}
},
"description": "Who the goal is assigned to"
},
"duration": {
"type": "object",
"properties": {
"end": {
"type": "string",
"description": "The end date of the goal"
},
"start": {
"type": "string",
"description": "The start date of the goal"
}
},
"description": "The duration of the goal"
},
"interval": {
"type": "string",
"description": "The interval of the goal"
},
"owner_id": {
"type": "integer",
"description": "The ID of the creator of the goal"
},
"is_active": {
"type": "boolean",
"description": "Whether the goal is currently active or not"
},
"report_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the reports that belong to the goal"
},
"expected_outcome": {
"type": "object",
"properties": {
"target": {
"type": "integer",
"description": "The numeric target of the goal"
},
"tracking_metric": {
"type": "string",
"description": "The tracking metric of the goal"
}
},
"description": "The expected outcome of the goal"
}
}
},
"progress": {
"type": "integer",
"description": "The numeric progress of the goal"
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
GoalsMarkAsDeletedResponse
{
"type": "object",
"title": "deleteGoalResponse200",
"properties": {
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
GoalsUpdateExistingGoalRequest
{
"type": "object",
"title": "basicGoalRequest",
"properties": {
"type": {
"type": "object",
"description": "The type of the goal. It requires the following JSON structure: `{ \"name\": \"deals_started\", \"params\": { \"pipeline_id\": [1, 2], \"activity_type_id\": [9] } }`. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. The `pipeline_id` and `activity_type_id` need to be given as an array of integers. To track the goal in all pipelines, set `pipeline_id` as `null` and similarly, to track the goal for all activities, set `activity_type_id` as `null`.”"
},
"title": {
"type": "string",
"description": "The title of the goal"
},
"assignee": {
"type": "object",
"description": "Who this goal is assigned to. It requires the following JSON structure: `{ \"id\": \"1\", \"type\": \"person\" }`. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team."
},
"duration": {
"type": "object",
"description": "The date when the goal starts and ends. It requires the following JSON structure: `{ \"start\": \"2019-01-01\", \"end\": \"2022-12-31\" }`. Date in format of YYYY-MM-DD. \"end\" can be set to `null` for an infinite, open-ended goal."
},
"interval": {
"enum": [
"weekly",
"monthly",
"quarterly",
"yearly"
],
"type": "string",
"description": "The interval of the goal"
},
"expected_outcome": {
"type": "object",
"description": "The expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: `{ \"target\": \"50\", \"tracking_metric\": \"quantity\" }` or `{ \"target\": \"50\", \"tracking_metric\": \"sum\", \"currency_id\": 1 }`. `currency_id` should only be added to `sum` type of goals."
}
}
}
GoalsUpdateExistingGoalResponse
{
"type": "object",
"title": "addOrUpdateGoalResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"goal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the goal"
},
"type": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the goal type"
},
"params": {
"type": "object",
"properties": {
"pipeline_id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of pipelines of the goal"
},
"activity_type_id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of activity types of the goal"
}
},
"description": "The parameters that accompany the goal type"
}
},
"description": "The type of the goal"
},
"title": {
"type": "string",
"description": "The title of the goal"
},
"assignee": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the goal assignee"
},
"type": {
"type": "string",
"description": "The type of the assignee"
}
},
"description": "Who the goal is assigned to"
},
"duration": {
"type": "object",
"properties": {
"end": {
"type": "string",
"description": "The end date of the goal"
},
"start": {
"type": "string",
"description": "The start date of the goal"
}
},
"description": "The duration of the goal"
},
"interval": {
"type": "string",
"description": "The interval of the goal"
},
"owner_id": {
"type": "integer",
"description": "The ID of the creator of the goal"
},
"is_active": {
"type": "boolean",
"description": "Whether the goal is currently active or not"
},
"report_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the reports that belong to the goal"
},
"expected_outcome": {
"type": "object",
"properties": {
"target": {
"type": "integer",
"description": "The numeric target of the goal"
},
"tracking_metric": {
"type": "string",
"description": "The tracking metric of the goal"
}
},
"description": "The expected outcome of the goal"
}
}
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
ItemSearchByFieldValuesResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the item"
},
"$field_key": {
"description": "The value of the searched `field_key`"
}
}
},
"description": "The array of results"
},
"additional_data": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Items shown per page"
},
"start": {
"type": "integer",
"description": "Pagination start"
},
"next_start": {
"type": "integer",
"description": "Next pagination start"
},
"more_items_in_collection": {
"type": "boolean",
"description": "Whether there are more list items in the collection than displayed"
}
},
"description": "Pagination details of the list"
}
}
}
}
}
],
"title": "searchItemByFieldResponse200"
}
ItemSearchSearchMultipleItemsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"type": "object",
"description": "Item"
},
"result_score": {
"type": "number",
"description": "Search result relevancy"
}
}
},
"description": "The array of found items"
},
"related_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"type": "object",
"description": "Item"
},
"result_score": {
"type": "number",
"description": "Search result relevancy"
}
}
},
"description": "The array of related items if `search_for_related_items` was enabled"
}
}
},
"additional_data": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Items shown per page"
},
"start": {
"type": "integer",
"description": "Pagination start"
},
"next_start": {
"type": "integer",
"description": "Next pagination start"
},
"more_items_in_collection": {
"type": "boolean",
"description": "Whether there are more list items in the collection than displayed"
}
},
"description": "Pagination details of the list"
}
}
}
}
}
],
"title": "searchItemResponse200"
}
LeadLabelsAddNewLabelRequest
{
"type": "object",
"title": "addLeadLabelRequest",
"required": [
"name",
"color"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the lead label"
},
"color": {
"enum": [
"green",
"blue",
"red",
"yellow",
"purple",
"gray"
],
"type": "string",
"description": "The color of the label. Only a subset of colors can be used."
}
}
}
LeadLabelsAddNewLabelResponse
{
"type": "object",
"title": "addOrUpdateLeadLabelResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the lead label"
},
"name": {
"type": "string",
"description": "The name of the lead label"
},
"color": {
"enum": [
"green",
"blue",
"red",
"yellow",
"purple",
"gray"
],
"type": "string",
"description": "The color of the label. Only a subset of colors can be used."
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead label was created. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead label was last updated. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
}
}
},
"success": {
"type": "boolean"
}
}
}
LeadLabelsDeleteLabel404Response
{
"type": "object",
"title": "leadResponse404",
"properties": {
"data": {
"type": "object",
"example": null,
"nullable": true
},
"error": {
"type": "string",
"description": "The description of the error"
},
"success": {
"type": "boolean",
"example": false
},
"error_info": {
"type": "string",
"description": "A message describing how to solve the problem"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
LeadLabelsDeleteLabelResponse
{
"type": "object",
"title": "leadIdResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
}
},
"success": {
"type": "boolean"
}
}
}
LeadLabelsGetAllResponse
{
"type": "object",
"title": "getLeadLabelsResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the lead label"
},
"name": {
"type": "string",
"description": "The name of the lead label"
},
"color": {
"enum": [
"green",
"blue",
"red",
"yellow",
"purple",
"gray"
],
"type": "string",
"description": "The color of the label. Only a subset of colors can be used."
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead label was created. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead label was last updated. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
}
}
}
},
"success": {
"type": "boolean"
}
}
}
LeadLabelsUpdateProperties404Response
{
"type": "object",
"title": "leadResponse404",
"properties": {
"data": {
"type": "object",
"example": null,
"nullable": true
},
"error": {
"type": "string",
"description": "The description of the error"
},
"success": {
"type": "boolean",
"example": false
},
"error_info": {
"type": "string",
"description": "A message describing how to solve the problem"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
LeadLabelsUpdatePropertiesRequest
{
"type": "object",
"title": "updateLeadLabelRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the lead label"
},
"color": {
"enum": [
"green",
"blue",
"red",
"yellow",
"purple",
"gray"
],
"type": "string",
"description": "The color of the label. Only a subset of colors can be used."
}
}
}
LeadLabelsUpdatePropertiesResponse
{
"type": "object",
"title": "addOrUpdateLeadLabelResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the lead label"
},
"name": {
"type": "string",
"description": "The name of the lead label"
},
"color": {
"enum": [
"green",
"blue",
"red",
"yellow",
"purple",
"gray"
],
"type": "string",
"description": "The color of the label. Only a subset of colors can be used."
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead label was created. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead label was last updated. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
}
}
},
"success": {
"type": "boolean"
}
}
}
LeadSourcesGetAllResponse
{
"type": "object",
"title": "getLeadSourcesResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The unique name of a lead source"
}
}
}
},
"success": {
"type": "boolean"
}
}
}
LeadsCreateLeadRequest
{
"type": "object",
"title": "addLeadRequest",
"required": [
"title"
],
"properties": {
"title": {
"type": "string",
"description": "The name of the lead"
},
"value": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "number"
},
"currency": {
"type": "string"
}
},
"description": "The potential value of the lead"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used."
},
"was_seen": {
"type": "boolean",
"description": "A flag indicating whether the lead was seen by someone in the Pipedrive UI"
},
"label_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "The IDs of the lead labels which will be associated with the lead"
},
"person_id": {
"type": "integer",
"description": "The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless `organization_id` is specified."
},
"visible_to": {
"type": "string",
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner & followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table>"
},
"organization_id": {
"type": "integer",
"description": "The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless `person_id` is specified."
},
"expected_close_date": {
"type": "string",
"format": "date",
"description": "The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD."
}
}
}
LeadsCreateLeadResponse
{
"type": "object",
"title": "oneLeadResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the lead in the UUID format"
},
"title": {
"type": "string",
"description": "The title of the lead"
},
"value": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "number"
},
"currency": {
"type": "string"
}
},
"description": "The potential value of the lead"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead was created. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
},
"cc_email": {
"type": "string",
"description": "The BCC email of the lead"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who owns the lead"
},
"was_seen": {
"type": "boolean",
"description": "A flag indicating whether the lead was seen by someone in the Pipedrive UI"
},
"label_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "The IDs of the lead labels which are associated with the lead"
},
"person_id": {
"type": "integer",
"nullable": true,
"description": "The ID of a person which this lead is linked to"
},
"creator_id": {
"type": "integer",
"description": "The ID of the user who created the lead"
},
"visible_to": {
"type": "string",
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner & followers (private)</td></tr><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>"
},
"is_archived": {
"type": "boolean",
"description": "A flag indicating whether the lead is archived or not"
},
"source_name": {
"type": "string",
"description": "Defines where the lead comes from. Will be `API` if the lead was created through the Public API and will be `Manually created` if the lead was created manually through the UI.\n"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead was last updated. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
},
"organization_id": {
"type": "integer",
"nullable": true,
"description": "The ID of an organization which this lead is linked to"
},
"next_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the next activity associated with the lead"
},
"expected_close_date": {
"type": "string",
"format": "date",
"nullable": true,
"description": "The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD."
}
}
},
"success": {
"type": "boolean"
}
}
}
LeadsDeleteLead404Response
{
"type": "object",
"title": "leadResponse404",
"properties": {
"data": {
"type": "object",
"example": null,
"nullable": true
},
"error": {
"type": "string",
"description": "The description of the error"
},
"success": {
"type": "boolean",
"example": false
},
"error_info": {
"type": "string",
"description": "A message describing how to solve the problem"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
LeadsDeleteLeadResponse
{
"type": "object",
"title": "leadIdResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
}
},
"success": {
"type": "boolean"
}
}
}
LeadsGetAllResponse
{
"type": "object",
"title": "getLeadsResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the lead in the UUID format"
},
"title": {
"type": "string",
"description": "The title of the lead"
},
"value": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "number"
},
"currency": {
"type": "string"
}
},
"description": "The potential value of the lead"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead was created. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
},
"cc_email": {
"type": "string",
"description": "The BCC email of the lead"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who owns the lead"
},
"was_seen": {
"type": "boolean",
"description": "A flag indicating whether the lead was seen by someone in the Pipedrive UI"
},
"label_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "The IDs of the lead labels which are associated with the lead"
},
"person_id": {
"type": "integer",
"nullable": true,
"description": "The ID of a person which this lead is linked to"
},
"creator_id": {
"type": "integer",
"description": "The ID of the user who created the lead"
},
"visible_to": {
"type": "string",
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner & followers (private)</td></tr><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>"
},
"is_archived": {
"type": "boolean",
"description": "A flag indicating whether the lead is archived or not"
},
"source_name": {
"type": "string",
"description": "Defines where the lead comes from. Will be `API` if the lead was created through the Public API and will be `Manually created` if the lead was created manually through the UI.\n"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead was last updated. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
},
"organization_id": {
"type": "integer",
"nullable": true,
"description": "The ID of an organization which this lead is linked to"
},
"next_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the next activity associated with the lead"
},
"expected_close_date": {
"type": "string",
"format": "date",
"nullable": true,
"description": "The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD."
}
}
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Items shown per page"
},
"start": {
"type": "integer",
"description": "Pagination start"
},
"more_items_in_collection": {
"type": "boolean",
"description": "If there are more list items in the collection than displayed or not"
}
},
"description": "The additional data of the list"
}
}
}
LeadsGetDetails404Response
{
"type": "object",
"title": "leadResponse404",
"properties": {
"data": {
"type": "object",
"example": null,
"nullable": true
},
"error": {
"type": "string",
"description": "The description of the error"
},
"success": {
"type": "boolean",
"example": false
},
"error_info": {
"type": "string",
"description": "A message describing how to solve the problem"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
LeadsGetDetailsResponse
{
"type": "object",
"title": "oneLeadResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the lead in the UUID format"
},
"title": {
"type": "string",
"description": "The title of the lead"
},
"value": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "number"
},
"currency": {
"type": "string"
}
},
"description": "The potential value of the lead"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead was created. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
},
"cc_email": {
"type": "string",
"description": "The BCC email of the lead"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who owns the lead"
},
"was_seen": {
"type": "boolean",
"description": "A flag indicating whether the lead was seen by someone in the Pipedrive UI"
},
"label_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "The IDs of the lead labels which are associated with the lead"
},
"person_id": {
"type": "integer",
"nullable": true,
"description": "The ID of a person which this lead is linked to"
},
"creator_id": {
"type": "integer",
"description": "The ID of the user who created the lead"
},
"visible_to": {
"type": "string",
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner & followers (private)</td></tr><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>"
},
"is_archived": {
"type": "boolean",
"description": "A flag indicating whether the lead is archived or not"
},
"source_name": {
"type": "string",
"description": "Defines where the lead comes from. Will be `API` if the lead was created through the Public API and will be `Manually created` if the lead was created manually through the UI.\n"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead was last updated. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
},
"organization_id": {
"type": "integer",
"nullable": true,
"description": "The ID of an organization which this lead is linked to"
},
"next_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the next activity associated with the lead"
},
"expected_close_date": {
"type": "string",
"format": "date",
"nullable": true,
"description": "The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD."
}
}
},
"success": {
"type": "boolean"
}
}
}
LeadsListPermittedUsersResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of user IDs"
}
}
}
],
"title": "userIds"
}
LeadsSearchLeadsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the lead"
},
"type": {
"type": "string",
"description": "The type of the item"
},
"notes": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of notes"
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the owner of the lead"
}
}
},
"title": {
"type": "string",
"description": "The title of the lead"
},
"value": {
"type": "integer",
"description": "The value of the lead"
},
"emails": {
"type": "array",
"items": {
"type": "string"
}
},
"person": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the person the lead is associated with"
},
"name": {
"type": "string",
"description": "The name of the person the lead is associated with"
}
}
},
"phones": {
"type": "array",
"items": {
"type": "string"
}
},
"currency": {
"type": "string",
"description": "The currency of the lead"
},
"visible_to": {
"type": "integer",
"description": "The visibility of the lead"
},
"is_archived": {
"type": "boolean",
"description": "A flag indicating whether the lead is archived or not"
},
"organization": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the organization the lead is associated with"
},
"name": {
"type": "string",
"description": "The name of the organization the lead is associated with"
}
}
},
"custom_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom fields"
}
}
},
"result_score": {
"type": "number",
"description": "Search result relevancy"
}
}
},
"description": "The array of leads"
}
}
},
"additional_data": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Items shown per page"
},
"start": {
"type": "integer",
"description": "Pagination start"
},
"next_start": {
"type": "integer",
"description": "Next pagination start"
},
"more_items_in_collection": {
"type": "boolean",
"description": "Whether there are more list items in the collection than displayed"
}
},
"description": "Pagination details of the list"
}
}
}
}
}
],
"title": "searchLeadsResponse200"
}
LeadsUpdateLeadProperties404Response
{
"type": "object",
"title": "leadResponse404",
"properties": {
"data": {
"type": "object",
"example": null,
"nullable": true
},
"error": {
"type": "string",
"description": "The description of the error"
},
"success": {
"type": "boolean",
"example": false
},
"error_info": {
"type": "string",
"description": "A message describing how to solve the problem"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
LeadsUpdateLeadPropertiesRequest
{
"type": "object",
"title": "updateLeadRequest",
"properties": {
"title": {
"type": "string",
"nullable": true,
"description": "The name of the lead"
},
"value": {
"type": "object",
"nullable": true,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "number"
},
"currency": {
"type": "string"
}
},
"description": "The potential value of the lead"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used."
},
"was_seen": {
"type": "boolean",
"description": "A flag indicating whether the lead was seen by someone in the Pipedrive UI"
},
"label_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "The IDs of the lead labels which will be associated with the lead"
},
"person_id": {
"type": "integer",
"nullable": true,
"description": "The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. A lead always has to be linked to a person or organization or both.\n"
},
"visible_to": {
"type": "string",
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner & followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table>"
},
"is_archived": {
"type": "boolean",
"description": "A flag indicating whether the lead is archived or not"
},
"organization_id": {
"type": "integer",
"nullable": true,
"description": "The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. A lead always has to be linked to a person or organization or both."
},
"expected_close_date": {
"type": "string",
"format": "date",
"nullable": true,
"description": "The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD."
}
}
}
LeadsUpdateLeadPropertiesResponse
{
"type": "object",
"title": "oneLeadResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique ID of the lead in the UUID format"
},
"title": {
"type": "string",
"description": "The title of the lead"
},
"value": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "number"
},
"currency": {
"type": "string"
}
},
"description": "The potential value of the lead"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead was created. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
},
"cc_email": {
"type": "string",
"description": "The BCC email of the lead"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who owns the lead"
},
"was_seen": {
"type": "boolean",
"description": "A flag indicating whether the lead was seen by someone in the Pipedrive UI"
},
"label_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "The IDs of the lead labels which are associated with the lead"
},
"person_id": {
"type": "integer",
"nullable": true,
"description": "The ID of a person which this lead is linked to"
},
"creator_id": {
"type": "integer",
"description": "The ID of the user who created the lead"
},
"visible_to": {
"type": "string",
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner & followers (private)</td></tr><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>"
},
"is_archived": {
"type": "boolean",
"description": "A flag indicating whether the lead is archived or not"
},
"source_name": {
"type": "string",
"description": "Defines where the lead comes from. Will be `API` if the lead was created through the Public API and will be `Manually created` if the lead was created manually through the UI.\n"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the lead was last updated. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
},
"organization_id": {
"type": "integer",
"nullable": true,
"description": "The ID of an organization which this lead is linked to"
},
"next_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the next activity associated with the lead"
},
"expected_close_date": {
"type": "string",
"format": "date",
"nullable": true,
"description": "The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD."
}
}
},
"success": {
"type": "boolean"
}
}
}
LegacyTeamsAddNewTeam403Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
LegacyTeamsAddNewTeamRequest
{
"type": "object",
"title": "addTeamRequest",
"required": [
"name",
"manager_id"
],
"properties": {
"name": {
"type": "string",
"description": "The team name"
},
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of user IDs"
},
"manager_id": {
"type": "integer",
"description": "The team manager ID"
},
"description": {
"type": "string",
"description": "The team description"
}
}
}