ProductsAddFollowerRequest
{
"type": "object",
"title": "addProductFollowerRequest",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"description": "The ID of the user"
}
}
}
ProductsAddFollowerResponse
{
"type": "object",
"title": "newFollowerResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the follower"
},
"user_id": {
"type": "integer",
"description": "The ID of the user that was added as follower"
},
"add_time": {
"type": "string",
"description": "The follower creation time. Format: YYYY-MM-DD HH:MM:SS"
},
"product_id": {
"type": "integer",
"description": "The ID of the product"
}
}
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
ProductsCreateProductRequest
{
"allOf": [
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the product"
}
}
},
{
"type": "object",
"title": "productRequest",
"required": [
"name"
],
"properties": {
"tax": {
"type": "number",
"default": 0,
"description": "The tax percentage"
},
"code": {
"type": "string",
"description": "The product code"
},
"unit": {
"type": "string",
"description": "The unit in which this product is sold"
},
"prices": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned."
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used."
},
"selectable": {
"type": "boolean",
"default": true,
"description": "Whether this product can be selected in deals or not"
},
"visible_to": {
"type": "string",
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "The visibility of the product. 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>"
},
"active_flag": {
"type": "boolean",
"default": true,
"description": "Whether this product will be made active or not"
}
}
}
],
"title": "addProductRequest"
}
ProductsCreateProductResponse
{
"type": "object",
"title": "getproductResponse200",
"properties": {
"data": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The ID of the product"
},
"tax": {
"type": "number",
"default": 0,
"description": "The ax percentage"
},
"code": {
"type": "string",
"description": "The product code"
},
"name": {
"type": "string",
"description": "The name of the product"
},
"unit": {
"type": "string",
"description": "The unit in which this product is sold"
},
"owner_id": {
"type": "object",
"description": "Information about the Pipedrive user who owns the product"
},
"selectable": {
"type": "boolean",
"default": true,
"description": "Whether this product is selected in deals or not"
},
"visible_to": {
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "Visibility of the product"
},
"active_flag": {
"type": "boolean",
"default": true,
"description": "Whether this product is active or not"
}
}
},
{
"type": "object",
"properties": {
"prices": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of objects, each containing: currency (string), price (number), cost (number, optional), overhead_cost (number, optional)"
}
}
}
]
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
},
"related_objects": {
"type": "object",
"properties": {
"deal": {
"type": "object",
"properties": {
"DEAL_ID": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deal associated with the item"
},
"title": {
"type": "string",
"description": "The title of the deal associated with the item"
},
"value": {
"type": "number",
"description": "The value of the deal that is associated with the item"
},
"status": {
"type": "string",
"description": "The status of the deal associated with the item"
},
"currency": {
"type": "string",
"description": "The currency of the deal value"
},
"stage_id": {
"type": "integer",
"description": "The ID of the stage the deal is currently at"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline the deal is in"
}
},
"description": "The ID of the deal which is associated with the item"
}
}
},
"user": {
"type": "object",
"properties": {
"USER_ID": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"type": "integer",
"description": "The ID of the user"
},
"name": {
"type": "string",
"description": "The name of the user"
},
"email": {
"type": "string",
"description": "The email of the user"
},
"has_pic": {
"type": "integer",
"description": "Whether the user has picture or not. 0 = No picture, 1 = Has picture."
},
"pic_hash": {
"type": "string",
"nullable": true,
"description": "The user picture hash"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not"
}
}
},
{
"type": "object",
"description": "The ID of the user"
}
],
"title": "userDataWithId"
}
}
},
"person": {
"type": "object",
"properties": {
"PERSON_ID": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the person associated with the item"
},
"name": {
"type": "string",
"description": "The name of the person associated with the item"
},
"email": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the email"
},
"value": {
"type": "string",
"description": "The email of the associated person"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary email or not"
}
}
},
"description": "The emails of the person associated with the item"
},
"phone": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the phone number"
},
"value": {
"type": "string",
"description": "The phone number of the person associated with the item"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary phone number or not"
}
}
},
"description": "The phone numbers of the person associated with the item"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the person that is associated with the item"
}
}
}
],
"description": "The ID of the person associated with the item"
}
}
},
"organization": {
"type": "object",
"properties": {
"ORGANIZATION_ID": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the organization associated with the item"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization associated with the item"
},
"address": {
"type": "string",
"description": "The address of the organization"
},
"cc_email": {
"type": "string",
"description": "The BCC email of the organization associated with the item"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the organization that is associated with the item"
},
"people_count": {
"type": "integer",
"description": "The number of people connected with the organization that is associated with the item"
}
}
}
],
"description": "The ID of the organization associated with the item"
}
}
}
}
}
}
}
ProductsDeleteFollowerResponse
{
"type": "object",
"title": "deleteProductFollowerResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"type": "integer"
}
],
"description": "The ID of the removed follower"
}
}
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
ProductsGetAllProductsResponse
{
"type": "object",
"title": "getProductsResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"title": "getproductResponse200",
"properties": {
"data": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The ID of the product"
},
"tax": {
"type": "number",
"default": 0,
"description": "The ax percentage"
},
"code": {
"type": "string",
"description": "The product code"
},
"name": {
"type": "string",
"description": "The name of the product"
},
"unit": {
"type": "string",
"description": "The unit in which this product is sold"
},
"owner_id": {
"type": "object",
"description": "Information about the Pipedrive user who owns the product"
},
"selectable": {
"type": "boolean",
"default": true,
"description": "Whether this product is selected in deals or not"
},
"visible_to": {
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "Visibility of the product"
},
"active_flag": {
"type": "boolean",
"default": true,
"description": "Whether this product is active or not"
}
}
},
{
"type": "object",
"properties": {
"prices": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of objects, each containing: currency (string), price (number), cost (number, optional), overhead_cost (number, optional)"
}
}
}
]
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
},
"related_objects": {
"type": "object",
"properties": {
"deal": {
"type": "object",
"properties": {
"DEAL_ID": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deal associated with the item"
},
"title": {
"type": "string",
"description": "The title of the deal associated with the item"
},
"value": {
"type": "number",
"description": "The value of the deal that is associated with the item"
},
"status": {
"type": "string",
"description": "The status of the deal associated with the item"
},
"currency": {
"type": "string",
"description": "The currency of the deal value"
},
"stage_id": {
"type": "integer",
"description": "The ID of the stage the deal is currently at"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline the deal is in"
}
},
"description": "The ID of the deal which is associated with the item"
}
}
},
"user": {
"type": "object",
"properties": {
"USER_ID": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"type": "integer",
"description": "The ID of the user"
},
"name": {
"type": "string",
"description": "The name of the user"
},
"email": {
"type": "string",
"description": "The email of the user"
},
"has_pic": {
"type": "integer",
"description": "Whether the user has picture or not. 0 = No picture, 1 = Has picture."
},
"pic_hash": {
"type": "string",
"nullable": true,
"description": "The user picture hash"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not"
}
}
},
{
"type": "object",
"description": "The ID of the user"
}
],
"title": "userDataWithId"
}
}
},
"person": {
"type": "object",
"properties": {
"PERSON_ID": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the person associated with the item"
},
"name": {
"type": "string",
"description": "The name of the person associated with the item"
},
"email": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the email"
},
"value": {
"type": "string",
"description": "The email of the associated person"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary email or not"
}
}
},
"description": "The emails of the person associated with the item"
},
"phone": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the phone number"
},
"value": {
"type": "string",
"description": "The phone number of the person associated with the item"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary phone number or not"
}
}
},
"description": "The phone numbers of the person associated with the item"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the person that is associated with the item"
}
}
}
],
"description": "The ID of the person associated with the item"
}
}
},
"organization": {
"type": "object",
"properties": {
"ORGANIZATION_ID": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the organization associated with the item"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization associated with the item"
},
"address": {
"type": "string",
"description": "The address of the organization"
},
"cc_email": {
"type": "string",
"description": "The BCC email of the organization associated with the item"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the organization that is associated with the item"
},
"people_count": {
"type": "integer",
"description": "The number of people connected with the organization that is associated with the item"
}
}
}
],
"description": "The ID of the organization associated with the item"
}
}
}
}
}
}
},
"description": "Array containing data for all products"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
},
"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"
},
"related_objects": {
"type": "object",
"properties": {
"deal": {
"type": "object",
"properties": {
"DEAL_ID": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deal associated with the item"
},
"title": {
"type": "string",
"description": "The title of the deal associated with the item"
},
"value": {
"type": "number",
"description": "The value of the deal that is associated with the item"
},
"status": {
"type": "string",
"description": "The status of the deal associated with the item"
},
"currency": {
"type": "string",
"description": "The currency of the deal value"
},
"stage_id": {
"type": "integer",
"description": "The ID of the stage the deal is currently at"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline the deal is in"
}
},
"description": "The ID of the deal which is associated with the item"
}
}
},
"user": {
"type": "object",
"properties": {
"USER_ID": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"type": "integer",
"description": "The ID of the user"
},
"name": {
"type": "string",
"description": "The name of the user"
},
"email": {
"type": "string",
"description": "The email of the user"
},
"has_pic": {
"type": "integer",
"description": "Whether the user has picture or not. 0 = No picture, 1 = Has picture."
},
"pic_hash": {
"type": "string",
"nullable": true,
"description": "The user picture hash"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not"
}
}
},
{
"type": "object",
"description": "The ID of the user"
}
],
"title": "userDataWithId"
}
}
},
"person": {
"type": "object",
"properties": {
"PERSON_ID": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the person associated with the item"
},
"name": {
"type": "string",
"description": "The name of the person associated with the item"
},
"email": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the email"
},
"value": {
"type": "string",
"description": "The email of the associated person"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary email or not"
}
}
},
"description": "The emails of the person associated with the item"
},
"phone": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the phone number"
},
"value": {
"type": "string",
"description": "The phone number of the person associated with the item"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary phone number or not"
}
}
},
"description": "The phone numbers of the person associated with the item"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the person that is associated with the item"
}
}
}
],
"description": "The ID of the person associated with the item"
}
}
},
"organization": {
"type": "object",
"properties": {
"ORGANIZATION_ID": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the organization associated with the item"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization associated with the item"
},
"address": {
"type": "string",
"description": "The address of the organization"
},
"cc_email": {
"type": "string",
"description": "The BCC email of the organization associated with the item"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the organization that is associated with the item"
},
"people_count": {
"type": "integer",
"description": "The number of people connected with the organization that is associated with the item"
}
}
}
],
"description": "The ID of the organization associated with the item"
}
}
}
}
}
}
}
ProductsGetDealsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deal"
},
"org_id": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization associated with the deal"
},
"address": {
"type": "string",
"description": "The address of the organization that is associated with the deal"
},
"cc_email": {
"type": "string",
"description": "The BCC email of the organization associated with the deal"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the organization that is associated with the deal"
},
"active_flag": {
"type": "boolean",
"description": "Whether the associated organization is active or not"
},
"people_count": {
"type": "integer",
"description": "The number of people connected with the organization that is associated with the deal"
}
},
"description": "The organization which is associated with the deal"
},
{
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "The ID of the organization associated with the deal"
}
}
}
],
"title": "dealOrganizationDataWithId"
},
"user_id": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the user"
},
"name": {
"type": "string",
"description": "The name of the user"
},
"email": {
"type": "string",
"description": "The email of the user"
},
"has_pic": {
"type": "boolean",
"description": "If the user has a picture or not"
},
"pic_hash": {
"type": "string",
"nullable": true,
"description": "The user picture hash"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not"
}
},
"description": "The user who is associated with the deal"
},
{
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "The ID of the user"
}
}
}
],
"title": "dealUserDataWithId"
},
"person_id": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the person associated with the deal"
},
"email": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the email"
},
"value": {
"type": "string",
"description": "The email of the associated person"
},
"primary": {
"type": "boolean",
"description": "If this is the primary email or not"
}
}
},
"description": "The emails of the person associated with the deal"
},
"phone": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the phone number"
},
"value": {
"type": "string",
"description": "The phone number of the person associated with the deal"
},
"primary": {
"type": "boolean",
"description": "If this is the primary phone number or not"
}
}
},
"description": "The phone numbers of the person associated with the deal"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the person that is associated with the deal"
},
"active_flag": {
"type": "boolean",
"description": "Whether the associated person is active or not"
}
},
"description": "The person who is associated with the deal"
},
{
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "The ID of the person associated with the deal"
}
}
}
],
"title": "dealPersonDataWithId"
},
"creator_user_id": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deal creator"
},
"name": {
"type": "string",
"description": "The name of the deal creator"
},
"email": {
"type": "string",
"description": "The email of the deal creator"
},
"value": {
"type": "integer",
"description": "The ID of the deal creator"
},
"has_pic": {
"type": "boolean",
"description": "If the creator has a picture or not"
},
"pic_hash": {
"type": "string",
"nullable": true,
"description": "The creator picture hash"
},
"active_flag": {
"type": "boolean",
"description": "Whether the creator is active or not"
}
},
"description": "The creator of the deal"
}
}
},
{
"type": "object",
"title": "baseDeal",
"properties": {
"label": {
"type": "string",
"description": "The label or multiple labels assigned to the deal"
},
"title": {
"type": "string",
"description": "The title of the deal"
},
"value": {
"type": "number",
"description": "The value of the deal"
},
"active": {
"type": "boolean",
"description": "Whether the deal is active or not"
},
"status": {
"type": "string",
"description": "The status of the deal"
},
"deleted": {
"type": "boolean",
"description": "Whether the deal is deleted or not"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the deal"
},
"cc_email": {
"type": "string",
"description": "The BCC email of the deal"
},
"currency": {
"type": "string",
"description": "The currency associated with the deal"
},
"org_name": {
"type": "string",
"description": "The name of the organization associated with the deal"
},
"stage_id": {
"type": "integer",
"description": "The ID of the deal stage"
},
"won_time": {
"type": "string",
"description": "The date and time of changing the deal status as won"
},
"lost_time": {
"type": "string",
"description": "The date and time of changing the deal status as lost"
},
"close_time": {
"type": "string",
"nullable": true,
"description": "The date and time of closing the deal"
},
"org_hidden": {
"type": "boolean",
"description": "If the organization that is associated with the deal is hidden or not"
},
"owner_name": {
"type": "string",
"description": "The name of the deal owner"
},
"visible_to": {
"type": "string",
"description": "The visibility of the deal"
},
"files_count": {
"type": "integer",
"description": "The number of files associated with the deal"
},
"lost_reason": {
"type": "string",
"nullable": true,
"description": "The reason for losing the deal"
},
"notes_count": {
"type": "integer",
"description": "The number of notes associated with the deal"
},
"person_name": {
"type": "string",
"description": "The name of the person associated with the deal"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline associated with the deal"
},
"probability": {
"type": "number",
"nullable": true,
"description": "The success probability percentage of the deal"
},
"rotten_time": {
"type": "string",
"nullable": true,
"description": "The date and time of changing the deal status as rotten"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the deal"
},
"person_hidden": {
"type": "boolean",
"description": "If the person that is associated with the deal is hidden or not"
},
"first_won_time": {
"type": "string",
"description": "The date and time of the first time changing the deal status as won"
},
"products_count": {
"type": "integer",
"description": "The number of products associated with the deal"
},
"stage_order_nr": {
"type": "integer",
"description": "The order number of the deal stage associated with the deal"
},
"weighted_value": {
"type": "number",
"description": "Probability times deal value. Probability can either be deal probability or if not set, then stage probability."
},
"followers_count": {
"type": "integer",
"description": "The number of followers associated with the deal"
},
"formatted_value": {
"type": "string",
"description": "The deal value formatted with selected currency. E.g. US$500"
},
"activities_count": {
"type": "integer",
"description": "The number of activities associated with the deal"
},
"last_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the last activity associated with the deal"
},
"next_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the next activity associated with the deal"
},
"stage_change_time": {
"type": "string",
"description": "The last updated date and time of the deal stage"
},
"last_activity_date": {
"type": "string",
"nullable": true,
"description": "The date of the last activity associated with the deal"
},
"next_activity_date": {
"type": "string",
"description": "The date of the next activity associated with the deal"
},
"next_activity_note": {
"type": "string",
"description": "The note of the next activity associated with the deal"
},
"next_activity_time": {
"type": "string",
"description": "The time of the next activity associated with the deal"
},
"next_activity_type": {
"type": "string",
"description": "The type of the next activity associated with the deal"
},
"participants_count": {
"type": "integer",
"description": "The number of participants associated with the deal"
},
"expected_close_date": {
"type": "string",
"format": "date",
"description": "The expected close date of the deal"
},
"email_messages_count": {
"type": "integer",
"description": "The number of emails associated with the deal"
},
"done_activities_count": {
"type": "integer",
"description": "The number of completed activities associated with the deal"
},
"next_activity_subject": {
"type": "string",
"description": "The subject of the next activity associated with the deal"
},
"next_activity_duration": {
"type": "string",
"description": "The duration of the next activity associated with the deal"
},
"last_incoming_mail_time": {
"type": "string",
"description": "The date and time of the last incoming email associated with the deal"
},
"last_outgoing_mail_time": {
"type": "string",
"description": "The date and time of the last outgoing email associated with the deal"
},
"undone_activities_count": {
"type": "integer",
"description": "The number of incomplete activities associated with the deal"
},
"weighted_value_currency": {
"type": "string",
"description": "The currency associated with the deal"
},
"formatted_weighted_value": {
"type": "string",
"description": "The weighted_value formatted with selected currency. E.g. US$500"
}
}
}
],
"title": "dealNonStrict"
},
"description": "The array of deals"
},
"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"
},
"related_objects": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"USER_ID": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"type": "integer",
"description": "The ID of the user"
},
"name": {
"type": "string",
"description": "The name of the user"
},
"email": {
"type": "string",
"description": "The email of the user"
},
"has_pic": {
"type": "integer",
"description": "Whether the user has picture or not. 0 = No picture, 1 = Has picture."
},
"pic_hash": {
"type": "string",
"nullable": true,
"description": "The user picture hash"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not"
}
}
},
{
"type": "object",
"description": "The ID of the user"
}
],
"title": "userDataWithId"
}
}
},
"stage": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the stage"
},
"name": {
"type": "string",
"description": "The name of the stage"
},
"add_time": {
"type": "string",
"description": "The stage creation time. Format: YYYY-MM-DD HH:MM:SS."
},
"order_nr": {
"type": "integer",
"description": "Defines the order of the stage"
},
"active_flag": {
"type": "boolean",
"description": "Whether the stage is active or deleted"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline to add the stage to"
},
"rotten_days": {
"type": "integer",
"description": "The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set."
},
"rotten_flag": {
"type": "boolean",
"description": "Whether deals in this stage can become rotten"
},
"update_time": {
"type": "string",
"description": "The stage update time. Format: YYYY-MM-DD HH:MM:SS."
},
"deal_probability": {
"type": "integer",
"description": "The success probability percentage of the deal. Used/shown when the deal weighted values are used."
}
}
},
"person": {
"type": "object",
"properties": {
"PERSON_ID": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"active_flag": {
"type": "boolean",
"description": "Whether the associated person is active or not"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the person associated with the item"
},
"name": {
"type": "string",
"description": "The name of the person associated with the item"
},
"email": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the email"
},
"value": {
"type": "string",
"description": "The email of the associated person"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary email or not"
}
}
},
"description": "The emails of the person associated with the item"
},
"phone": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the phone number"
},
"value": {
"type": "string",
"description": "The phone number of the person associated with the item"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary phone number or not"
}
}
},
"description": "The phone numbers of the person associated with the item"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the person that is associated with the item"
}
}
}
],
"description": "The ID of the person associated with the item"
}
}
},
"pipeline": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the pipeline"
},
"name": {
"type": "string",
"description": "The name of the pipeline"
},
"active": {
"type": "boolean",
"description": "Whether this pipeline will be made inactive (hidden) or active"
},
"add_time": {
"type": "string",
"description": "The pipeline creation time. Format: YYYY-MM-DD HH:MM:SS."
},
"order_nr": {
"type": "integer",
"description": "Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline."
},
"url_title": {
"type": "string",
"description": "The pipeline title displayed in the URL"
},
"update_time": {
"type": "string",
"description": "The pipeline update time. Format: YYYY-MM-DD HH:MM:SS."
},
"deal_probability": {
"type": "boolean",
"description": "Whether deal probability is disabled or enabled for this pipeline"
}
}
},
"organization": {
"type": "object",
"properties": {
"ORGANIZATION_ID": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"active_flag": {
"type": "boolean",
"description": "Whether the associated organization is active or not"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the organization associated with the item"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization associated with the item"
},
"address": {
"type": "string",
"description": "The address of the organization"
},
"cc_email": {
"type": "string",
"description": "The BCC email of the organization associated with the item"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the organization that is associated with the item"
},
"people_count": {
"type": "integer",
"description": "The number of people connected with the organization that is associated with the item"
}
}
}
],
"description": "The ID of the organization associated with the item"
}
],
"description": "The ID of the organization associated with the item"
}
}
}
}
}
}
}
],
"title": "getAssociatedDealsResponse200"
}
ProductsGetDetailsResponse
{
"type": "object",
"title": "getproductResponse200",
"properties": {
"data": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The ID of the product"
},
"tax": {
"type": "number",
"default": 0,
"description": "The ax percentage"
},
"code": {
"type": "string",
"description": "The product code"
},
"name": {
"type": "string",
"description": "The name of the product"
},
"unit": {
"type": "string",
"description": "The unit in which this product is sold"
},
"owner_id": {
"type": "object",
"description": "Information about the Pipedrive user who owns the product"
},
"selectable": {
"type": "boolean",
"default": true,
"description": "Whether this product is selected in deals or not"
},
"visible_to": {
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "Visibility of the product"
},
"active_flag": {
"type": "boolean",
"default": true,
"description": "Whether this product is active or not"
}
}
},
{
"type": "object",
"properties": {
"prices": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of objects, each containing: currency (string), price (number), cost (number, optional), overhead_cost (number, optional)"
}
}
}
]
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
},
"related_objects": {
"type": "object",
"properties": {
"deal": {
"type": "object",
"properties": {
"DEAL_ID": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deal associated with the item"
},
"title": {
"type": "string",
"description": "The title of the deal associated with the item"
},
"value": {
"type": "number",
"description": "The value of the deal that is associated with the item"
},
"status": {
"type": "string",
"description": "The status of the deal associated with the item"
},
"currency": {
"type": "string",
"description": "The currency of the deal value"
},
"stage_id": {
"type": "integer",
"description": "The ID of the stage the deal is currently at"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline the deal is in"
}
},
"description": "The ID of the deal which is associated with the item"
}
}
},
"user": {
"type": "object",
"properties": {
"USER_ID": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"type": "integer",
"description": "The ID of the user"
},
"name": {
"type": "string",
"description": "The name of the user"
},
"email": {
"type": "string",
"description": "The email of the user"
},
"has_pic": {
"type": "integer",
"description": "Whether the user has picture or not. 0 = No picture, 1 = Has picture."
},
"pic_hash": {
"type": "string",
"nullable": true,
"description": "The user picture hash"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not"
}
}
},
{
"type": "object",
"description": "The ID of the user"
}
],
"title": "userDataWithId"
}
}
},
"person": {
"type": "object",
"properties": {
"PERSON_ID": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the person associated with the item"
},
"name": {
"type": "string",
"description": "The name of the person associated with the item"
},
"email": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the email"
},
"value": {
"type": "string",
"description": "The email of the associated person"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary email or not"
}
}
},
"description": "The emails of the person associated with the item"
},
"phone": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the phone number"
},
"value": {
"type": "string",
"description": "The phone number of the person associated with the item"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary phone number or not"
}
}
},
"description": "The phone numbers of the person associated with the item"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the person that is associated with the item"
}
}
}
],
"description": "The ID of the person associated with the item"
}
}
},
"organization": {
"type": "object",
"properties": {
"ORGANIZATION_ID": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the organization associated with the item"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization associated with the item"
},
"address": {
"type": "string",
"description": "The address of the organization"
},
"cc_email": {
"type": "string",
"description": "The BCC email of the organization associated with the item"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the organization that is associated with the item"
},
"people_count": {
"type": "integer",
"description": "The number of people connected with the organization that is associated with the item"
}
}
}
],
"description": "The ID of the organization associated with the item"
}
}
}
}
}
}
}
ProductsListPermittedUsersResponse
{
"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"
}
ProductsListProductFilesResponse
{
"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 file"
},
"url": {
"type": "string",
"description": "The URL to download the file"
},
"name": {
"type": "string",
"description": "The visible name of the file"
},
"add_time": {
"type": "string",
"description": "The UTC date time when the file was uploaded. Format: YYYY-MM-DD HH:MM:SS"
},
"file_name": {
"type": "string",
"description": "The original name of the file"
},
"file_size": {
"type": "integer",
"description": "The size of the file in bytes"
},
"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 associated with the file"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not."
},
"description": {
"type": "string",
"description": "The description of the file"
},
"inline_flag": {
"type": "boolean",
"description": "Whether the file was uploaded as inline or not"
},
"update_time": {
"type": "string",
"description": "The UTC date time when the file was last updated. Format: YYYY-MM-DD HH:MM:SS"
},
"product_name": {
"type": "string",
"description": "The name of the product associated with the file"
},
"remote_location": {
"type": "string",
"description": "The location type to send the file to. Only googledrive is supported at the moment."
}
},
"description": "The file data"
},
"description": "The array of files"
},
"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"
}
}
}
],
"title": "getAssociatedFilesResponse200"
}
ProductsListProductFollowersResponse
{
"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 user follower"
},
"user_id": {
"type": "integer",
"description": "The ID of the user"
},
"add_time": {
"type": "string",
"description": "The date and time when the follower was added to the person"
},
"product_id": {
"type": "integer",
"description": "The ID of the product"
}
}
},
"description": "The list of followers"
},
"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"
}
}
}
],
"title": "getProductFollowersResponseSuccess"
}
ProductsMarkAsDeletedResponse
{
"type": "object",
"title": "deleteProductResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"type": "integer"
}
],
"description": "The ID of the removed product"
}
}
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
ProductsSearchByFieldsResponse
{
"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": "integer",
"description": "The ID of the product"
},
"code": {
"type": "integer",
"description": "The code of the product"
},
"name": {
"type": "string",
"description": "The name of the product"
},
"type": {
"type": "string",
"description": "The type of the item"
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the owner of the product"
}
}
},
"visible_to": {
"type": "integer",
"description": "The visibility of the product"
},
"custom_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "The custom fields"
}
}
},
"result_score": {
"type": "number",
"description": "Search result relevancy"
}
}
},
"description": "The array of found items"
}
}
},
"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": "searchProductsResponse200"
}
ProductsUpdateProductDataRequest
{
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the product"
}
}
},
{
"type": "object",
"title": "productRequest",
"required": [
"name"
],
"properties": {
"tax": {
"type": "number",
"default": 0,
"description": "The tax percentage"
},
"code": {
"type": "string",
"description": "The product code"
},
"unit": {
"type": "string",
"description": "The unit in which this product is sold"
},
"prices": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned."
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used."
},
"selectable": {
"type": "boolean",
"default": true,
"description": "Whether this product can be selected in deals or not"
},
"visible_to": {
"type": "string",
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "The visibility of the product. 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>"
},
"active_flag": {
"type": "boolean",
"default": true,
"description": "Whether this product will be made active or not"
}
}
}
],
"title": "addProductRequest"
}
ProductsUpdateProductDataResponse
{
"type": "object",
"title": "updateProductResponse200",
"properties": {
"data": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The ID of the product"
},
"tax": {
"type": "number",
"default": 0,
"description": "The ax percentage"
},
"code": {
"type": "string",
"description": "The product code"
},
"name": {
"type": "string",
"description": "The name of the product"
},
"unit": {
"type": "string",
"description": "The unit in which this product is sold"
},
"owner_id": {
"type": "object",
"description": "Information about the Pipedrive user who owns the product"
},
"selectable": {
"type": "boolean",
"default": true,
"description": "Whether this product is selected in deals or not"
},
"visible_to": {
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "Visibility of the product"
},
"active_flag": {
"type": "boolean",
"default": true,
"description": "Whether this product is active or not"
}
}
},
{
"type": "object",
"properties": {
"prices": {
"type": "object",
"description": "Object of objects, each containing: currency (string), price (number), cost (number, optional), overhead_cost (number, optional)"
}
}
}
]
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
},
"related_objects": {
"type": "object",
"properties": {
"deal": {
"type": "object",
"properties": {
"DEAL_ID": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deal associated with the item"
},
"title": {
"type": "string",
"description": "The title of the deal associated with the item"
},
"value": {
"type": "number",
"description": "The value of the deal that is associated with the item"
},
"status": {
"type": "string",
"description": "The status of the deal associated with the item"
},
"currency": {
"type": "string",
"description": "The currency of the deal value"
},
"stage_id": {
"type": "integer",
"description": "The ID of the stage the deal is currently at"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline the deal is in"
}
},
"description": "The ID of the deal which is associated with the item"
}
}
},
"user": {
"type": "object",
"properties": {
"USER_ID": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"type": "integer",
"description": "The ID of the user"
},
"name": {
"type": "string",
"description": "The name of the user"
},
"email": {
"type": "string",
"description": "The email of the user"
},
"has_pic": {
"type": "integer",
"description": "Whether the user has picture or not. 0 = No picture, 1 = Has picture."
},
"pic_hash": {
"type": "string",
"nullable": true,
"description": "The user picture hash"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not"
}
}
},
{
"type": "object",
"description": "The ID of the user"
}
],
"title": "userDataWithId"
}
}
},
"person": {
"type": "object",
"properties": {
"PERSON_ID": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the person associated with the item"
},
"name": {
"type": "string",
"description": "The name of the person associated with the item"
},
"email": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the email"
},
"value": {
"type": "string",
"description": "The email of the associated person"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary email or not"
}
}
},
"description": "The emails of the person associated with the item"
},
"phone": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The type of the phone number"
},
"value": {
"type": "string",
"description": "The phone number of the person associated with the item"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary phone number or not"
}
}
},
"description": "The phone numbers of the person associated with the item"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the person that is associated with the item"
}
}
}
],
"description": "The ID of the person associated with the item"
}
}
},
"organization": {
"type": "object",
"properties": {
"ORGANIZATION_ID": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the organization associated with the item"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization associated with the item"
},
"address": {
"type": "string",
"description": "The address of the organization"
},
"cc_email": {
"type": "string",
"description": "The BCC email of the organization associated with the item"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner of the organization that is associated with the item"
},
"people_count": {
"type": "integer",
"description": "The number of people connected with the organization that is associated with the item"
}
}
}
],
"description": "The ID of the organization associated with the item"
}
}
}
}
}
}
}
ProjectTemplatesGetAllTemplatesResponse
{
"type": "object",
"title": "getProjectTemplatesResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The ID of a template"
},
"title": {
"type": "string",
"description": "The title of a template"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the template in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"owner_id": {
"type": "number",
"description": "The ID of a template owner"
},
"description": {
"type": "string",
"description": "The description of a template"
},
"update_time": {
"type": "string",
"description": "The update date and time of the template in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"projects_board_id": {
"type": "number",
"description": "The ID of the project board this template is associated with"
}
}
}
],
"title": "templateResponseObject"
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"properties": {
"next_cursor": {
"type": "string",
"description": "The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned."
}
},
"description": "The additional data of the list"
}
}
}
ProjectTemplatesGetBoardDetailsResponse
{
"type": "object",
"title": "getProjectBoardResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the project board"
},
"name": {
"type": "string",
"description": "Name of a project board"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"order_nr": {
"type": "number",
"description": "The order of a board"
},
"update_time": {
"type": "string",
"description": "The update date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
ProjectTemplatesGetDetailsResponse
{
"type": "object",
"title": "getProjectTemplateResponse200",
"properties": {
"data": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The ID of a template"
},
"title": {
"type": "string",
"description": "The title of a template"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the template in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"owner_id": {
"type": "number",
"description": "The ID of a template owner"
},
"description": {
"type": "string",
"description": "The description of a template"
},
"update_time": {
"type": "string",
"description": "The update date and time of the template in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"projects_board_id": {
"type": "number",
"description": "The ID of the project board this template is associated with"
}
}
}
],
"title": "templateResponseObject"
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
ProjectTemplatesGetPhaseDetailsResponse
{
"type": "object",
"title": "getProjectPhaseResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the project phase"
},
"name": {
"type": "string",
"description": "Name of a project phase"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"board_id": {
"type": "number",
"description": "The ID of the project board this phase is linked to"
},
"order_nr": {
"type": "number",
"description": "The order of a phase"
},
"update_time": {
"type": "string",
"description": "The update date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
ProjectsArchiveProjectResponse
{
"type": "object",
"title": "updateProjectResponse200",
"properties": {
"data": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the project, generated when the task was created"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the project"
},
"board_id": {
"type": "number",
"description": "The ID of the board this project is associated with"
},
"phase_id": {
"type": "number",
"description": "The ID of the phase this project is associated with"
}
}
},
{
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the labels this project has"
},
"org_id": {
"type": "number",
"description": "The ID of the organization this project is associated with"
},
"status": {
"type": "string",
"description": "The status of the project"
},
"deal_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the deals this project is associated with"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the project. Format: YYYY-MM-DD."
},
"owner_id": {
"type": "number",
"description": "The ID of a project owner"
},
"person_id": {
"type": "number",
"description": "The ID of the person this project is associated with"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the project. Format: YYYY-MM-DD."
},
"description": {
"type": "string",
"description": "The description of the project"
}
}
},
{
"type": "object",
"properties": {
"add_time": {
"type": "string",
"description": "The creation date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"update_time": {
"type": "string",
"description": "The update date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"archive_time": {
"type": "string",
"description": "The archived date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. If not archived then 'null'."
},
"status_change_time": {
"type": "string",
"description": "The status changed date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
}
],
"title": "fullProjectObject"
}
],
"title": "projectResponseObject"
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
ProjectsCreateProjectRequest
{
"allOf": [
{
"type": "object",
"title": "requiredPostProjectParameters",
"required": [
"title",
"board_id",
"phase_id"
],
"properties": {
"title": {
"type": "string",
"description": "The title of the project"
},
"board_id": {
"type": "number",
"description": "The ID of a project board"
},
"phase_id": {
"type": "number",
"description": "The ID of a phase on a project board"
}
}
},
{
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the labels this project has"
},
"org_id": {
"type": "number",
"description": "The ID of the organization this project is associated with"
},
"status": {
"type": "string",
"description": "The status of the project"
},
"deal_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the deals this project is associated with"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the project. Format: YYYY-MM-DD."
},
"owner_id": {
"type": "number",
"description": "The ID of a project owner"
},
"person_id": {
"type": "number",
"description": "The ID of the person this project is associated with"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the project. Format: YYYY-MM-DD."
},
"description": {
"type": "string",
"description": "The description of the project"
}
}
},
{
"type": "object",
"properties": {
"template_id": {
"type": "number",
"description": "The ID of the template the project will be based on"
}
}
}
],
"title": "addProjectRequest"
}
ProjectsCreateProjectResponse
{
"type": "object",
"title": "addProjectResponse201",
"properties": {
"data": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the project, generated when the task was created"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the project"
},
"board_id": {
"type": "number",
"description": "The ID of the board this project is associated with"
},
"phase_id": {
"type": "number",
"description": "The ID of the phase this project is associated with"
}
}
},
{
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the labels this project has"
},
"org_id": {
"type": "number",
"description": "The ID of the organization this project is associated with"
},
"status": {
"type": "string",
"description": "The status of the project"
},
"deal_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the deals this project is associated with"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the project. Format: YYYY-MM-DD."
},
"owner_id": {
"type": "number",
"description": "The ID of a project owner"
},
"person_id": {
"type": "number",
"description": "The ID of the person this project is associated with"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the project. Format: YYYY-MM-DD."
},
"description": {
"type": "string",
"description": "The description of the project"
}
}
},
{
"type": "object",
"properties": {
"add_time": {
"type": "string",
"description": "The creation date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"update_time": {
"type": "string",
"description": "The update date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"archive_time": {
"type": "string",
"description": "The archived date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. If not archived then 'null'."
},
"status_change_time": {
"type": "string",
"description": "The status changed date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
}
],
"title": "fullProjectObject"
}
],
"title": "projectResponseObject"
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
ProjectsGetAllBoardsResponse
{
"type": "object",
"title": "getProjectBoardsResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the project board"
},
"name": {
"type": "string",
"description": "Name of a project board"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"order_nr": {
"type": "number",
"description": "The order of a board"
},
"update_time": {
"type": "string",
"description": "The update date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
ProjectsGetAllProjectsResponse
{
"type": "object",
"title": "getProjectsResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the project, generated when the task was created"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the project"
},
"board_id": {
"type": "number",
"description": "The ID of the board this project is associated with"
},
"phase_id": {
"type": "number",
"description": "The ID of the phase this project is associated with"
}
}
},
{
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the labels this project has"
},
"org_id": {
"type": "number",
"description": "The ID of the organization this project is associated with"
},
"status": {
"type": "string",
"description": "The status of the project"
},
"deal_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the deals this project is associated with"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the project. Format: YYYY-MM-DD."
},
"owner_id": {
"type": "number",
"description": "The ID of a project owner"
},
"person_id": {
"type": "number",
"description": "The ID of the person this project is associated with"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the project. Format: YYYY-MM-DD."
},
"description": {
"type": "string",
"description": "The description of the project"
}
}
},
{
"type": "object",
"properties": {
"add_time": {
"type": "string",
"description": "The creation date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"update_time": {
"type": "string",
"description": "The update date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"archive_time": {
"type": "string",
"description": "The archived date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. If not archived then 'null'."
},
"status_change_time": {
"type": "string",
"description": "The status changed date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
}
],
"title": "fullProjectObject"
}
],
"title": "projectResponseObject"
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"properties": {
"next_cursor": {
"type": "string",
"description": "The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned."
}
},
"description": "The additional data of the list"
}
}
}
ProjectsGetDetailsResponse
{
"type": "object",
"title": "getProjectResponse200",
"properties": {
"data": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the project, generated when the task was created"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the project"
},
"board_id": {
"type": "number",
"description": "The ID of the board this project is associated with"
},
"phase_id": {
"type": "number",
"description": "The ID of the phase this project is associated with"
}
}
},
{
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the labels this project has"
},
"org_id": {
"type": "number",
"description": "The ID of the organization this project is associated with"
},
"status": {
"type": "string",
"description": "The status of the project"
},
"deal_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the deals this project is associated with"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the project. Format: YYYY-MM-DD."
},
"owner_id": {
"type": "number",
"description": "The ID of a project owner"
},
"person_id": {
"type": "number",
"description": "The ID of the person this project is associated with"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the project. Format: YYYY-MM-DD."
},
"description": {
"type": "string",
"description": "The description of the project"
}
}
},
{
"type": "object",
"properties": {
"add_time": {
"type": "string",
"description": "The creation date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"update_time": {
"type": "string",
"description": "The update date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"archive_time": {
"type": "string",
"description": "The archived date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. If not archived then 'null'."
},
"status_change_time": {
"type": "string",
"description": "The status changed date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
}
],
"title": "fullProjectObject"
}
],
"title": "projectResponseObject"
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
ProjectsGetGroupsResponse
{
"type": "object",
"title": "getProjectGroupsResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of the group"
},
"name": {
"type": "string",
"description": "Name of the group"
},
"order_nr": {
"type": "number",
"description": "Order number of the group"
}
}
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
ProjectsGetPhasesResponse
{
"type": "object",
"title": "getProjectPhasesResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the project phase"
},
"name": {
"type": "string",
"description": "Name of a project phase"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"board_id": {
"type": "number",
"description": "The ID of the project board this phase is linked to"
},
"order_nr": {
"type": "number",
"description": "The order of a phase"
},
"update_time": {
"type": "string",
"description": "The update date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
ProjectsGetProjectActivitiesResponse
{
"type": "object",
"title": "getActivitiesCollectionResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"org_id": {
"type": "integer",
"description": "The ID of the organization this activity is associated with"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal this activity is associated with"
},
"lead_id": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "The ID of the lead in the UUID format this activity is associated with"
},
"due_date": {
"type": "string",
"format": "date",
"description": "The due date of the activity. Format: YYYY-MM-DD"
},
"due_time": {
"type": "string",
"description": "The due time of the activity in UTC. Format: HH:MM"
},
"duration": {
"type": "string",
"description": "The duration of the activity. Format: HH:MM"
},
"location": {
"type": "string",
"description": "The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps."
},
"person_id": {
"type": "integer",
"description": "The ID of the person this activity is associated with"
},
"project_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the project this activity is associated with"
},
"public_description": {
"type": "string",
"description": "Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity."
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the activity, generated when the activity was created"
},
"done": {
"type": "boolean",
"description": "Whether the activity is done or not"
},
"type": {
"type": "string",
"description": "The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes."
},
"subject": {
"type": "string",
"description": "The subject of the activity"
},
"user_id": {
"type": "integer",
"description": "The ID of the user whom the activity is assigned to"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"busy_flag": {
"type": "boolean",
"description": "Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time."
},
"company_id": {
"type": "integer",
"description": "The user's company ID"
},
"active_flag": {
"type": "boolean",
"description": "Whether the activity is active or not"
},
"update_time": {
"type": "string",
"description": "The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS."
},
"location_route": {
"type": "string",
"description": "A subfield of the location field. Indicates street name."
},
"update_user_id": {
"type": "integer",
"description": "The ID of the user who was the last to update this activity"
},
"source_timezone": {
"type": "string",
"description": "The timezone the activity was created in an external calendar"
},
"location_country": {
"type": "string",
"description": "A subfield of the location field. Indicates country."
},
"location_locality": {
"type": "string",
"description": "A subfield of the location field. Indicates city/town/village/locality."
},
"location_subpremise": {
"type": "string",
"description": "A subfield of the location field. Indicates apartment/suite number."
},
"marked_as_done_time": {
"type": "string",
"description": "The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS."
},
"location_postal_code": {
"type": "string",
"description": "A subfield of the location field. Indicates ZIP/postal code."
},
"location_sublocality": {
"type": "string",
"description": "A subfield of the location field. Indicates district/sublocality."
},
"conference_meeting_id": {
"type": "string",
"description": "The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity"
},
"conference_meeting_url": {
"type": "string",
"description": "The link to join the meeting which is associated with this activity"
},
"location_street_number": {
"type": "string",
"description": "A subfield of the location field. Indicates house number."
},
"conference_meeting_client": {
"type": "string",
"description": "The ID of the Marketplace app, which is connected to this activity"
},
"location_formatted_address": {
"type": "string",
"description": "A subfield of the location field. Indicates full/combined address."
},
"location_admin_area_level_1": {
"type": "string",
"description": "A subfield of the location field. Indicates state/county."
},
"location_admin_area_level_2": {
"type": "string",
"description": "A subfield of the location field. Indicates region."
}
}
}
],
"title": "activityCollectionResponseObject"
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"properties": {
"next_cursor": {
"type": "string",
"description": "The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned."
}
},
"description": "The additional data of the list"
}
}
}
ProjectsGetProjectPlanResponse
{
"type": "object",
"title": "getProjectPlanResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "number",
"description": "ID of plan item (either activity or task ID)"
},
"group_id": {
"type": "number",
"description": "The ID of the board this project is associated with. If null then plan item is not in any group."
},
"phase_id": {
"type": "number",
"description": "The ID of the board this project is associated with. If null then plan item is not in any phase."
},
"item_type": {
"type": "string",
"description": "Type of a plan item (task / activity)"
}
}
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
ProjectsGetProjectTasksResponse
{
"type": "object",
"title": "getTasksResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the task, generated when the task was created"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the task"
},
"project_id": {
"type": "number",
"description": "The ID of the project this task is associated with"
}
}
},
{
"type": "object",
"properties": {
"done": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether the task is done or not. 0 = Not done, 1 = Done."
},
"due_date": {
"type": "string",
"format": "date",
"description": "The due date of the task. Format: YYYY-MM-DD."
},
"assignee_id": {
"type": "number",
"description": "The ID of the user who will be the assignee of the task"
},
"description": {
"type": "string",
"description": "The description of the task"
},
"parent_task_id": {
"type": "number",
"description": "The ID of a parent task. Can not be ID of a task which is already a subtask."
}
}
},
{
"type": "object",
"properties": {
"add_time": {
"type": "string",
"description": "The creation date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"creator_id": {
"type": "number",
"description": "The creator of a task"
},
"update_time": {
"type": "string",
"description": "The update date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"marked_as_done_time": {
"type": "string",
"description": "The marked as done date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
}
],
"title": "updateProjectRequest"
}
],
"title": "taskResponseObject"
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"properties": {
"next_cursor": {
"type": "string",
"description": "The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned."
}
},
"description": "The additional data of the list"
}
}
}
ProjectsMarkAsDeletedResponse
{
"type": "object",
"title": "deleteProjectResponse200",
"properties": {
"data": {
"type": "object",
"title": "deleteProject",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the project that was deleted"
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
ProjectsUpdatePlanTaskRequest
{
"type": "object",
"title": "projectPutPlanItemBodyObject",
"properties": {
"group_id": {
"type": "number",
"description": "The ID of a group on a project board"
},
"phase_id": {
"type": "number",
"description": "The ID of a phase on a project board"
}
}
}
ProjectsUpdatePlanTaskResponse
{
"type": "object",
"title": "updatedTaskPlanItem_200",
"properties": {
"data": {
"type": "object",
"properties": {
"item_id": {
"type": "number",
"description": "ID of plan item (either activity or task ID)"
},
"group_id": {
"type": "number",
"description": "The ID of the board this project is associated with. If null then plan item is not in any group."
},
"phase_id": {
"type": "number",
"description": "The ID of the board this project is associated with. If null then plan item is not in any phase."
},
"item_type": {
"type": "string",
"description": "Type of a plan item (task / activity)"
}
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
ProjectsUpdateProjectPlanActivityRequest
{
"type": "object",
"title": "projectPutPlanItemBodyObject",
"properties": {
"group_id": {
"type": "number",
"description": "The ID of a group on a project board"
},
"phase_id": {
"type": "number",
"description": "The ID of a phase on a project board"
}
}
}
ProjectsUpdateProjectPlanActivityResponse
{
"type": "object",
"title": "updatedActivityPlanItem_200",
"properties": {
"data": {
"type": "object",
"properties": {
"item_id": {
"type": "number",
"description": "ID of plan item (either activity or task ID)"
},
"group_id": {
"type": "number",
"description": "The ID of the board this project is associated with. If null then plan item is not in any group."
},
"phase_id": {
"type": "number",
"description": "The ID of the board this project is associated with. If null then plan item is not in any phase."
},
"item_type": {
"type": "string",
"description": "Type of a plan item (task / activity)"
}
}
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
ProjectsUpdateProjectRequest
{
"allOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the project"
},
"board_id": {
"type": "number",
"description": "The ID of the board this project is associated with"
},
"phase_id": {
"type": "number",
"description": "The ID of the phase this project is associated with"
}
}
},
{
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the labels this project has"
},
"org_id": {
"type": "number",
"description": "The ID of the organization this project is associated with"
},
"status": {
"type": "string",
"description": "The status of the project"
},
"deal_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the deals this project is associated with"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the project. Format: YYYY-MM-DD."
},
"owner_id": {
"type": "number",
"description": "The ID of a project owner"
},
"person_id": {
"type": "number",
"description": "The ID of the person this project is associated with"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the project. Format: YYYY-MM-DD."
},
"description": {
"type": "string",
"description": "The description of the project"
}
}
}
],
"title": "updateProjectRequest"
}
ProjectsUpdateProjectResponse
{
"type": "object",
"title": "updateProjectResponse200",
"properties": {
"data": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the project, generated when the task was created"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the project"
},
"board_id": {
"type": "number",
"description": "The ID of the board this project is associated with"
},
"phase_id": {
"type": "number",
"description": "The ID of the phase this project is associated with"
}
}
},
{
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the labels this project has"
},
"org_id": {
"type": "number",
"description": "The ID of the organization this project is associated with"
},
"status": {
"type": "string",
"description": "The status of the project"
},
"deal_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of IDs of the deals this project is associated with"
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the project. Format: YYYY-MM-DD."
},
"owner_id": {
"type": "number",
"description": "The ID of a project owner"
},
"person_id": {
"type": "number",
"description": "The ID of the person this project is associated with"
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the project. Format: YYYY-MM-DD."
},
"description": {
"type": "string",
"description": "The description of the project"
}
}
},
{
"type": "object",
"properties": {
"add_time": {
"type": "string",
"description": "The creation date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"update_time": {
"type": "string",
"description": "The update date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"archive_time": {
"type": "string",
"description": "The archived date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. If not archived then 'null'."
},
"status_change_time": {
"type": "string",
"description": "The status changed date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS."
}
}
}
],
"title": "fullProjectObject"
}
],
"title": "projectResponseObject"
},
"success": {
"type": "boolean"
},
"additional_data": {
"type": "object",
"example": null,
"nullable": true
}
}
}
RecentsGetChangesAfterResponse
{
"type": "object",
"title": "getRecentsResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"data": {
"allOf": [
{
"type": "object",
"properties": {
"org_id": {
"type": "integer",
"description": "The ID of the organization this activity is associated with"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal this activity is associated with"
},
"lead_id": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "The ID of the lead in the UUID format this activity is associated with"
},
"due_date": {
"type": "string",
"format": "date",
"description": "The due date of the activity. Format: YYYY-MM-DD"
},
"due_time": {
"type": "string",
"description": "The due time of the activity in UTC. Format: HH:MM"
},
"duration": {
"type": "string",
"description": "The duration of the activity. Format: HH:MM"
},
"location": {
"type": "string",
"description": "The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps."
},
"person_id": {
"type": "integer",
"description": "The ID of the person this activity is associated with"
},
"project_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the project this activity is associated with"
},
"public_description": {
"type": "string",
"description": "Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity."
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the activity, generated when the activity was created"
},
"done": {
"type": "boolean",
"description": "Whether the activity is done or not"
},
"file": {
"type": "object",
"description": "The file that is attached to this activity. For example, this can be a reference to an audio note file generated with Pipedrive mobile app."
},
"note": {
"type": "string",
"description": "The note of the activity (HTML format)"
},
"type": {
"type": "string",
"description": "The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes."
},
"series": {
"type": "array",
"items": {
"type": "object"
},
"description": "The list of recurring activity instances. It is in a structure as follows: `[{due_date: \"2020-06-24\", due_time: \"10:00:00\"}]`"
},
"subject": {
"type": "string",
"description": "The subject of the activity"
},
"user_id": {
"type": "integer",
"description": "The ID of the user whom the activity is assigned to"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS."
},
"org_name": {
"type": "string",
"description": "The name of the organization this activity is associated with"
},
"rec_rule": {
"type": "string",
"description": "The rule for the recurrence of the activity. Is important for activities synced into Pipedrive from an external calendar. Example: \"RRULE:FREQ=WEEKLY;BYDAY=WE\""
},
"attendees": {
"type": "array",
"items": {
"type": "object"
},
"nullable": true,
"description": "The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address."
},
"busy_flag": {
"type": "boolean",
"description": "Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time."
},
"company_id": {
"type": "integer",
"description": "The user's company ID"
},
"deal_title": {
"type": "string",
"description": "The name of the deal this activity is associated with"
},
"owner_name": {
"type": "string",
"description": "The name of the user this activity is owned by"
},
"active_flag": {
"type": "boolean",
"description": "Whether the activity is active or not"
},
"person_name": {
"type": "string",
"description": "The name of the person this activity is associated with"
},
"update_time": {
"type": "string",
"description": "The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS."
},
"participants": {
"type": "array",
"items": {
"type": "object"
},
"nullable": true,
"description": "List of multiple persons (participants) this activity is associated with"
},
"reference_id": {
"type": "integer",
"description": "Together with the `reference_type`, gives the ID of the other object"
},
"gcal_event_id": {
"type": "string",
"description": "For the activity which syncs to Google calendar, this is the Google event ID. NB! This field is related to old Google calendar sync and will be deprecated soon."
},
"location_route": {
"type": "string",
"description": "A subfield of the location field. Indicates street name."
},
"reference_type": {
"type": "string",
"description": "If the activity references some other object, it is indicated here. For example, value `Salesphone` refers to activities created with Caller."
},
"update_user_id": {
"type": "integer",
"description": "The ID of the user who was the last to update this activity"
},
"source_timezone": {
"type": "string",
"description": "The timezone the activity was created in an external calendar"
},
"deal_dropbox_bcc": {
"type": "string",
"description": "The BCC email address of the deal"
},
"location_country": {
"type": "string",
"description": "A subfield of the location field. Indicates country."
},
"location_locality": {
"type": "string",
"description": "A subfield of the location field. Indicates city/town/village/locality."
},
"created_by_user_id": {
"type": "integer",
"description": "The ID of the user who created the activity"
},
"google_calendar_id": {
"type": "string",
"description": "The Google calendar ID that this activity syncs to. NB! This field is related to old Google calendar sync and will be deprecated soon."
},
"person_dropbox_bcc": {
"type": "string",
"description": "The BCC email address of the person"
},
"rec_rule_extension": {
"type": "string",
"description": "Additional rules for the recurrence of the activity, extend the `rec_rule`. Is important for activities synced into Pipedrive from an external calendar."
},
"assigned_to_user_id": {
"type": "integer",
"description": "The ID of the user to whom the activity is assigned to. Equal to `user_id`."
},
"location_subpremise": {
"type": "string",
"description": "A subfield of the location field. Indicates apartment/suite number."
},
"marked_as_done_time": {
"type": "string",
"description": "The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS."
},
"google_calendar_etag": {
"type": "string",
"description": "The Google calendar API etag (version) that is used for syncing this activity. NB! This field is related to old Google calendar sync and will be deprecated soon."
},
"location_postal_code": {
"type": "string",
"description": "A subfield of the location field. Indicates ZIP/postal code."
},
"location_sublocality": {
"type": "string",
"description": "A subfield of the location field. Indicates district/sublocality."
},
"conference_meeting_id": {
"type": "string",
"description": "The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity"
},
"conference_meeting_url": {
"type": "string",
"description": "The link to join the meeting which is associated with this activity"
},
"last_notification_time": {
"type": "string",
"description": "The date and time of latest notifications sent about this activity to the participants or the attendees of this activity"
},
"location_street_number": {
"type": "string",
"description": "A subfield of the location field. Indicates house number."
},
"rec_master_activity_id": {
"type": "integer",
"description": "The ID of parent activity for a recurrent activity if the current activity is an exception to recurrence rules"
},
"notification_language_id": {
"type": "integer",
"description": "The ID of the language the notifications are sent in"
},
"conference_meeting_client": {
"type": "string",
"description": "The ID of the Marketplace app, which is connected to this activity"
},
"last_notification_user_id": {
"type": "integer",
"description": "The ID of the user who triggered the sending of the latest notifications about this activity to the participants or the attendees of this activity"
},
"location_formatted_address": {
"type": "string",
"description": "A subfield of the location field. Indicates full/combined address."
},
"location_admin_area_level_1": {
"type": "string",
"description": "A subfield of the location field. Indicates state/county."
},
"location_admin_area_level_2": {
"type": "string",
"description": "A subfield of the location field. Indicates region."
},
"calendar_sync_include_context": {
"type": "string",
"description": "For activities that sync to an external calendar, this setting indicates if the activity syncs with context (what are the deals, persons, organizations this activity is related to)"
}
}
}
],
"title": "activityResponseObject"
},
"item": {
"enum": [
"activity"
],
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the activity type"
},
"name": {
"type": "string",
"description": "The name of the activity type"
},
"color": {
"type": "string",
"description": "A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The creation time of the activity type"
},
"icon_key": {
"enum": [
"task",
"email",
"meeting",
"deadline",
"call",
"lunch",
"calendar",
"downarrow",
"document",
"smartphone",
"camera",
"scissors",
"cogs",
"bubble",
"uparrow",
"checkbox",
"signpost",
"shuffle",
"addressbook",
"linegraph",
"picture",
"car",
"world",
"search",
"clip",
"sound",
"brush",
"key",
"padlock",
"pricetag",
"suitcase",
"finish",
"plane",
"loop",
"wifi",
"truck",
"cart",
"bulb",
"bell",
"presentation"
],
"type": "string",
"description": "Icon graphic to use for representing this activity type"
},
"order_nr": {
"type": "integer",
"description": "An order number for the activity type. Order numbers should be used to order the types in the activity type selections."
},
"key_string": {
"type": "string",
"description": "A string that is generated by the API based on the given name of the activity type upon creation"
},
"active_flag": {
"type": "boolean",
"description": "The active flag of the activity type"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The update time of the activity type"
},
"is_custom_flag": {
"type": "boolean",
"description": "Whether the activity type is a custom one or not"
}
}
},
"item": {
"enum": [
"activityType"
],
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"data": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deal"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization associated with the deal"
},
"user_id": {
"type": "integer",
"description": "The ID of the user"
},
"person_id": {
"type": "integer",
"description": "The ID of the person associated with the deal"
},
"creator_user_id": {
"type": "integer",
"description": "The ID of the deal creator"
}
}
},
{
"type": "object",
"title": "baseDeal",
"properties": {
"label": {
"type": "string",
"description": "The label or multiple labels assigned to the deal"
},
"title": {
"type": "string",
"description": "The title of the deal"
},
"value": {
"type": "number",
"description": "The value of the deal"
},
"active": {
"type": "boolean",
"description": "Whether the deal is active or not"
},
"status": {
"type": "string",
"description": "The status of the deal"
},
"deleted": {
"type": "boolean",
"description": "Whether the deal is deleted or not"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the deal"
},
"cc_email": {
"type": "string",
"description": "The BCC email of the deal"
},
"currency": {
"type": "string",
"description": "The currency associated with the deal"
},
"org_name": {
"type": "string",
"description": "The name of the organization associated with the deal"
},
"stage_id": {
"type": "integer",
"description": "The ID of the deal stage"
},
"won_time": {
"type": "string",
"description": "The date and time of changing the deal status as won"
},
"lost_time": {
"type": "string",
"description": "The date and time of changing the deal status as lost"
},
"close_time": {
"type": "string",
"nullable": true,
"description": "The date and time of closing the deal"
},
"org_hidden": {
"type": "boolean",
"description": "If the organization that is associated with the deal is hidden or not"
},
"owner_name": {
"type": "string",
"description": "The name of the deal owner"
},
"visible_to": {
"type": "string",
"description": "The visibility of the deal"
},
"files_count": {
"type": "integer",
"description": "The number of files associated with the deal"
},
"lost_reason": {
"type": "string",
"nullable": true,
"description": "The reason for losing the deal"
},
"notes_count": {
"type": "integer",
"description": "The number of notes associated with the deal"
},
"person_name": {
"type": "string",
"description": "The name of the person associated with the deal"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline associated with the deal"
},
"probability": {
"type": "number",
"nullable": true,
"description": "The success probability percentage of the deal"
},
"rotten_time": {
"type": "string",
"nullable": true,
"description": "The date and time of changing the deal status as rotten"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the deal"
},
"person_hidden": {
"type": "boolean",
"description": "If the person that is associated with the deal is hidden or not"
},
"first_won_time": {
"type": "string",
"description": "The date and time of the first time changing the deal status as won"
},
"products_count": {
"type": "integer",
"description": "The number of products associated with the deal"
},
"stage_order_nr": {
"type": "integer",
"description": "The order number of the deal stage associated with the deal"
},
"weighted_value": {
"type": "number",
"description": "Probability times deal value. Probability can either be deal probability or if not set, then stage probability."
},
"followers_count": {
"type": "integer",
"description": "The number of followers associated with the deal"
},
"formatted_value": {
"type": "string",
"description": "The deal value formatted with selected currency. E.g. US$500"
},
"activities_count": {
"type": "integer",
"description": "The number of activities associated with the deal"
},
"last_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the last activity associated with the deal"
},
"next_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the next activity associated with the deal"
},
"stage_change_time": {
"type": "string",
"description": "The last updated date and time of the deal stage"
},
"last_activity_date": {
"type": "string",
"nullable": true,
"description": "The date of the last activity associated with the deal"
},
"next_activity_date": {
"type": "string",
"description": "The date of the next activity associated with the deal"
},
"next_activity_note": {
"type": "string",
"description": "The note of the next activity associated with the deal"
},
"next_activity_time": {
"type": "string",
"description": "The time of the next activity associated with the deal"
},
"next_activity_type": {
"type": "string",
"description": "The type of the next activity associated with the deal"
},
"participants_count": {
"type": "integer",
"description": "The number of participants associated with the deal"
},
"expected_close_date": {
"type": "string",
"format": "date",
"description": "The expected close date of the deal"
},
"email_messages_count": {
"type": "integer",
"description": "The number of emails associated with the deal"
},
"done_activities_count": {
"type": "integer",
"description": "The number of completed activities associated with the deal"
},
"next_activity_subject": {
"type": "string",
"description": "The subject of the next activity associated with the deal"
},
"next_activity_duration": {
"type": "string",
"description": "The duration of the next activity associated with the deal"
},
"last_incoming_mail_time": {
"type": "string",
"description": "The date and time of the last incoming email associated with the deal"
},
"last_outgoing_mail_time": {
"type": "string",
"description": "The date and time of the last outgoing email associated with the deal"
},
"undone_activities_count": {
"type": "integer",
"description": "The number of incomplete activities associated with the deal"
},
"weighted_value_currency": {
"type": "string",
"description": "The currency associated with the deal"
},
"formatted_weighted_value": {
"type": "string",
"description": "The weighted_value formatted with selected currency. E.g. US$500"
}
}
}
],
"title": "dealStrict"
},
"item": {
"enum": [
"deal"
],
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"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 dile"
},
"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"
},
"item": {
"enum": [
"file"
],
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"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"
},
"item": {
"enum": [
"filter"
],
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the note"
},
"deal": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the deal this note is attached to"
}
},
"description": "The deal this note is attached to"
},
"user": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the note creator"
},
"email": {
"type": "string",
"description": "The email of the note creator"
},
"is_you": {
"type": "boolean",
"description": "Whether the note is created by you or not"
},
"icon_url": {
"type": "string",
"description": "The URL of the note creator avatar picture"
}
},
"description": "The user who created the note"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization the note is attached to"
},
"person": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the person the note is attached to"
}
},
"description": "The person the note is attached to"
},
"content": {
"type": "string",
"description": "The content of the note in HTML format. Subject to sanitization on the back-end."
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal the note is attached to"
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead the note is attached to"
},
"user_id": {
"type": "integer",
"description": "The ID of the note creator"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the note"
},
"person_id": {
"type": "integer",
"description": "The ID of the person the note is attached to"
},
"active_flag": {
"type": "boolean",
"description": "Whether the note is active or deleted"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the note"
},
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization the note is attached to"
}
},
"description": "The organization the note is attached to"
},
"last_update_user_id": {
"type": "integer",
"description": "The ID of the user who last updated the note"
},
"pinned_to_deal_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to deal pinning state"
},
"pinned_to_person_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to person pinning state"
},
"pinned_to_organization_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to organization pinning state"
}
}
},
"item": {
"enum": [
"note"
],
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"data": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the person"
},
"email": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The label that indicates the type of the email. (Possible values - work, home or other)"
},
"value": {
"type": "string",
"description": "Email"
},
"primary": {
"type": "boolean",
"description": "Boolean that indicates if email is primary for the person or not"
}
}
},
"description": "An email address as a string or an array of email objects related to the person. The structure of the array is as follows: `[{ \"value\": \"mail@example.com\", \"primary\": \"true\", \"label\": \"main\" } ]`. Please note that only `value` is required."
},
"label": {
"type": "integer",
"description": "The label assigned to the person"
},
"phone": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The label that indicates the type of the phone number. (Possible values - work, home, mobile or other)"
},
"value": {
"type": "string",
"description": "The phone number"
},
"primary": {
"type": "boolean",
"description": "Boolean that indicates if phone number is primary for the person or not"
}
}
},
"description": "A phone number supplied as a string or an array of phone objects related to the person. The structure of the array is as follows: `[{ \"value\": \"12345\", \"primary\": \"true\", \"label\": \"mobile\" }]`. Please note that only `value` is required."
},
"add_time": {
"type": "string",
"description": "The date and time when the person was added/created. Format: YYYY-MM-DD HH:MM:SS"
},
"cc_email": {
"type": "string",
"description": "The BCC email associated with the person"
},
"org_name": {
"type": "string",
"description": "The name of the organization associated with the person"
},
"company_id": {
"type": "integer",
"description": "The ID of the company related to the person"
},
"first_char": {
"type": "string",
"description": "The first letter of the name of the person"
},
"owner_name": {
"type": "string",
"description": "The name of the owner associated with the person"
},
"picture_id": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the picture associated with the item"
}
}
},
{
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "The ID of related item"
},
"add_time": {
"type": "string",
"description": "The add time of the picture"
},
"pictures": {
"type": "object",
"properties": {
"128": {
"type": "string",
"description": "The URL of the 128*128 picture"
},
"512": {
"type": "string",
"description": "The URL of the 512*512 picture"
}
}
},
"item_type": {
"type": "string",
"description": "The type of item the picture is related to"
},
"active_flag": {
"type": "boolean",
"description": "Whether the associated picture is active or not"
},
"update_time": {
"type": "string",
"description": "The update time of the picture"
},
"added_by_user_id": {
"type": "integer",
"description": "The ID of the user who added the picture"
}
}
}
]
},
"visible_to": {
"type": "string",
"description": "The visibility group ID of who can see the person"
},
"active_flag": {
"type": "boolean",
"description": "Whether the person is active or not"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the person. Format: YYYY-MM-DD HH:MM:SS"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"org_id": {
"type": "integer",
"description": "The ID of the organization related to the person"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner related to the person"
},
"merge_what_id": {
"type": "integer",
"description": "The ID of the person with what the main person was merged"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the person"
},
"last_name": {
"type": "string",
"description": "The last name of the person"
},
"first_name": {
"type": "string",
"description": "The first name of the person"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"files_count": {
"type": "integer",
"description": "The count of files related to the person"
},
"notes_count": {
"type": "integer",
"description": "The count of notes related to the person"
},
"followers_count": {
"type": "integer",
"description": "The count of followers related to the person"
},
"activities_count": {
"type": "integer",
"description": "The count of activities related to the person"
},
"email_messages_count": {
"type": "integer",
"description": "The count of email messages related to the person"
},
"done_activities_count": {
"type": "integer",
"description": "The count of done activities related to the person"
},
"undone_activities_count": {
"type": "integer",
"description": "The count of undone activities related to the person"
}
}
},
{
"type": "object",
"properties": {
"last_incoming_mail_time": {
"type": "string",
"description": "The date and time of the last incoming email associated with the person"
},
"last_outgoing_mail_time": {
"type": "string",
"description": "The date and time of the last outgoing email associated with the person"
}
}
}
],
"title": "personCountAndEmailInfo"
}
],
"title": "personNameCountAndEmailInfo"
}
],
"title": "personNameCountAndEmailInfoWithIds"
},
{
"type": "object",
"allOf": [
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"won_deals_count": {
"type": "integer",
"description": "The count of won deals related with the item"
},
"lost_deals_count": {
"type": "integer",
"description": "The count of lost deals related with the item"
},
"open_deals_count": {
"type": "integer",
"description": "The count of open deals related with the item"
},
"closed_deals_count": {
"type": "integer",
"description": "The count of closed deals related with the item"
},
"related_won_deals_count": {
"type": "integer",
"description": "The count of related won deals related with the item"
},
"related_lost_deals_count": {
"type": "integer",
"description": "The count of related lost deals related with the item"
},
"related_open_deals_count": {
"type": "integer",
"description": "The count of related open deals related with the item"
},
"related_closed_deals_count": {
"type": "integer",
"description": "The count of related closed deals related with the item"
}
}
},
{
"type": "object",
"properties": {
"last_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the last activity associated with the deal"
},
"next_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the next activity associated with the deal"
},
"last_activity_date": {
"type": "string",
"nullable": true,
"description": "The date of the last activity associated with the deal"
},
"next_activity_date": {
"type": "string",
"nullable": true,
"description": "The date of the next activity associated with the deal"
},
"next_activity_time": {
"type": "string",
"nullable": true,
"description": "The time of the next activity associated with the deal"
}
}
}
],
"title": "dealCountAndActivityInfo"
},
{
"type": "object",
"properties": {
"participant_open_deals_count": {
"type": "integer",
"description": "The count of open participant deals related with the item"
},
"participant_closed_deals_count": {
"type": "integer",
"description": "The count of closed participant deals related with the item"
}
}
}
],
"title": "mergePersonDealRelatedInfo"
}
],
"title": "additionalMergePersonInfo"
}
],
"title": "mergePersonItem"
},
"item": {
"enum": [
"person"
],
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"data": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the organization"
},
"name": {
"type": "string",
"description": "The name of the organization"
},
"label": {
"type": "integer",
"description": "The label assigned to the organization"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the organization"
},
"cc_email": {
"type": "string",
"description": "The BCC email associated with the organization"
},
"owner_id": {
"allOf": [
{
"properties": {
"id": {
"type": "integer",
"description": "The ID of the user"
},
"name": {
"type": "string",
"description": "The name of the user"
},
"email": {
"type": "string",
"description": "The email of the user"
},
"has_pic": {
"type": "integer",
"description": "Whether the user has picture or not. 0 = No picture, 1 = Has picture."
},
"pic_hash": {
"type": "string",
"nullable": true,
"description": "The user picture hash"
},
"active_flag": {
"type": "boolean",
"description": "Whether the user is active or not"
}
}
},
{
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "The ID of the owner"
}
}
}
],
"title": "owner"
},
"company_id": {
"type": "integer",
"description": "The ID of the company related to the organization"
},
"first_char": {
"type": "string",
"description": "The first character of the organization name"
},
"owner_name": {
"type": "string",
"description": "The name of the organization owner"
},
"picture_id": {
"allOf": [
{
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "The ID of the picture associated with the item"
}
}
},
{
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "The ID of related item"
},
"add_time": {
"type": "string",
"description": "The add time of the picture"
},
"pictures": {
"type": "object",
"properties": {
"128": {
"type": "string",
"description": "The URL of the 128*128 picture"
},
"512": {
"type": "string",
"description": "The URL of the 512*512 picture"
}
}
},
"item_type": {
"type": "string",
"description": "The type of item the picture is related to"
},
"active_flag": {
"type": "boolean",
"description": "Whether the associated picture is active or not"
},
"update_time": {
"type": "string",
"description": "The update time of the picture"
},
"added_by_user_id": {
"type": "integer",
"description": "The ID of the user who added the picture"
}
}
}
]
},
"visible_to": {
"type": "string",
"description": "The visibility group ID of who can see the organization"
},
"active_flag": {
"type": "boolean",
"description": "Whether the organization is active or not"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the organization"
},
"country_code": {
"type": "string",
"nullable": true,
"description": "The country code of the organization"
}
}
},
{
"type": "object",
"allOf": [
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"files_count": {
"type": "integer",
"description": "The count of files related to the organization"
},
"notes_count": {
"type": "integer",
"description": "The count of notes related to the organization"
},
"people_count": {
"type": "integer",
"description": "The count of persons related to the organization"
},
"followers_count": {
"type": "integer",
"description": "The count of followers related to the organization"
},
"activities_count": {
"type": "integer",
"description": "The count of activities related to the organization"
},
"email_messages_count": {
"type": "integer",
"description": "The count of email messages related to the organization"
},
"done_activities_count": {
"type": "integer",
"description": "The count of done activities related to the organization"
},
"undone_activities_count": {
"type": "integer",
"description": "The count of undone activities related to the organization"
}
}
},
{
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "The full address of the organization"
},
"address_route": {
"type": "string",
"description": "The route of the organization location"
},
"address_country": {
"type": "string",
"description": "The country of the organization location"
},
"address_locality": {
"type": "string",
"description": "The locality of the organization location"
},
"address_subpremise": {
"type": "string",
"description": "The sub-premise of the organization location"
},
"address_postal_code": {
"type": "string",
"description": "The postal code of the organization location"
},
"address_sublocality": {
"type": "string",
"description": "The sub-locality of the organization location"
},
"address_street_number": {
"type": "string",
"description": "The street number of the organization location"
},
"address_formatted_address": {
"type": "string",
"description": "The formatted organization location"
},
"address_admin_area_level_1": {
"type": "string",
"description": "The level 1 admin area of the organization location"
},
"address_admin_area_level_2": {
"type": "string",
"description": "The level 2 admin area of the organization location"
}
}
}
],
"title": "organizationCountAndAddressInfo"
},
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"won_deals_count": {
"type": "integer",
"description": "The count of won deals related with the item"
},
"lost_deals_count": {
"type": "integer",
"description": "The count of lost deals related with the item"
},
"open_deals_count": {
"type": "integer",
"description": "The count of open deals related with the item"
},
"closed_deals_count": {
"type": "integer",
"description": "The count of closed deals related with the item"
},
"related_won_deals_count": {
"type": "integer",
"description": "The count of related won deals related with the item"
},
"related_lost_deals_count": {
"type": "integer",
"description": "The count of related lost deals related with the item"
},
"related_open_deals_count": {
"type": "integer",
"description": "The count of related open deals related with the item"
},
"related_closed_deals_count": {
"type": "integer",
"description": "The count of related closed deals related with the item"
}
}
},
{
"type": "object",
"properties": {
"last_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the last activity associated with the deal"
},
"next_activity_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the next activity associated with the deal"
},
"last_activity_date": {
"type": "string",
"nullable": true,
"description": "The date of the last activity associated with the deal"
},
"next_activity_date": {
"type": "string",
"nullable": true,
"description": "The date of the next activity associated with the deal"
},
"next_activity_time": {
"type": "string",
"nullable": true,
"description": "The time of the next activity associated with the deal"
}
}
}
],
"title": "dealsCountAndActivityInfo"
}
],
"title": "additionalBaseOrganizationItemInfo"
}
],
"title": "baseOrganizationItem"
},
"item": {
"enum": [
"organization"
],
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the pipeline"
},
"name": {
"type": "string",
"description": "The name of the pipeline"
},
"active": {
"type": "boolean",
"description": "Whether this pipeline will be made inactive (hidden) or active"
},
"add_time": {
"type": "string",
"description": "The pipeline creation time. Format: YYYY-MM-DD HH:MM:SS."
},
"order_nr": {
"type": "integer",
"description": "Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline."
},
"url_title": {
"type": "string",
"description": "The pipeline title displayed in the URL"
},
"update_time": {
"type": "string",
"description": "The pipeline update time. Format: YYYY-MM-DD HH:MM:SS."
},
"deal_probability": {
"type": "boolean",
"description": "Whether deal probability is disabled or enabled for this pipeline"
}
}
},
"item": {
"enum": [
"pipeline"
],
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the product"
},
"tax": {
"type": "number",
"default": 0,
"description": "The tax percentage"
},
"code": {
"type": "string",
"description": "The product code"
},
"name": {
"type": "string",
"description": "The name of the product"
},
"unit": {
"type": "string",
"description": "The unit in which this product is sold"
},
"prices": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned."
},
"add_time": {
"type": "string",
"description": "The date and time when the product was added to the deal"
},
"category": {
"type": "string",
"description": "The category of the product"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who will be marked as the owner of this product. When omitted, authorized user ID will be used."
},
"first_char": {
"type": "string",
"description": "The first letter of the product name"
},
"selectable": {
"type": "boolean",
"description": "Whether this product can be selected in deals or not"
},
"visible_to": {
"type": "integer",
"description": "The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user."
},
"active_flag": {
"type": "boolean",
"description": "Whether this product will be made active or not"
},
"description": {
"type": "string",
"description": "The description of the product"
},
"files_count": {
"type": "integer",
"description": "The count of files"
},
"update_time": {
"type": "string",
"description": "The date and time when the product was updated to the deal"
}
}
},
"item": {
"enum": [
"product"
],
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the stage"
},
"name": {
"type": "string",
"description": "The name of the stage"
},
"add_time": {
"type": "string",
"description": "The stage creation time. Format: YYYY-MM-DD HH:MM:SS."
},
"order_nr": {
"type": "integer",
"description": "Defines the order of the stage"
},
"active_flag": {
"type": "boolean",
"description": "Whether the stage is active or deleted"
},
"pipeline_id": {
"type": "integer",
"description": "The ID of the pipeline to add the stage to"
},
"rotten_days": {
"type": "integer",
"description": "The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set."
},
"rotten_flag": {
"type": "boolean",
"description": "Whether deals in this stage can become rotten"
},
"update_time": {
"type": "string",
"description": "The stage update time. Format: YYYY-MM-DD HH:MM:SS."
},
"deal_probability": {
"type": "integer",
"description": "The success probability percentage of the deal. Used/shown when the deal weighted values are used."
}
}
},
"item": {
"enum": [
"stage"
],
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The user ID"
},
"lang": {
"type": "integer",
"description": "The user language ID"
},
"name": {
"type": "string",
"description": "The user name"
},
"email": {
"type": "string",
"description": "The user email"
},
"phone": {
"type": "string",
"nullable": true,
"description": "The user phone"
},
"access": {
"type": "array",
"items": {
"type": "object",
"properties": {
"app": {
"enum": [
"sales",
"projects",
"campaigns",
"global",
"account_settings"
],
"type": "string"
},
"admin": {
"type": "boolean"
},
"permission_set_id": {
"type": "string"
}
}
}
},
"is_you": {
"type": "boolean",
"description": "Boolean that indicates if the requested user is the same which is logged in (in this case, always true)"
},
"locale": {
"type": "string",
"description": "The user locale"
},
"created": {
"type": "string",
"description": "The creation date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"role_id": {
"type": "integer",
"description": "The ID of the user role"
},
"icon_url": {
"type": "string",
"nullable": true,
"description": "The user icon URL"
},
"modified": {
"type": "string",
"nullable": true,
"description": "The last modification date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"activated": {
"type": "boolean",
"description": "Boolean that indicates whether the user is activated"
},
"last_login": {
"type": "string",
"description": "The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS"
},
"active_flag": {
"type": "boolean",
"description": "Boolean that indicates whether the user is activated"
},
"timezone_name": {
"type": "string",
"description": "The user timezone name"
},
"timezone_offset": {
"type": "string",
"description": "The user timezone offset"
},
"default_currency": {
"type": "string",
"description": "The user default currency"
},
"has_created_company": {
"type": "boolean",
"description": "Boolean that indicates whether the user has created a company"
}
}
},
"item": {
"enum": [
"user"
],
"type": "string"
}
}
}
]
}
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
},
"additional_data": {
"type": "object",
"properties": {
"pagination": {
"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"
},
"since_timestamp": {
"type": "string",
"description": "The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS"
},
"last_timestamp_on_page": {
"type": "string",
"description": "The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS"
}
}
}
}
}
RolesAddOrUpdateSettingRequest
{
"type": "object",
"title": "addOrUpdateRoleSettingRequest",
"required": [
"setting_key",
"value"
],
"properties": {
"value": {
"enum": [
1,
3,
5,
7
],
"type": "integer",
"description": "Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class='role-setting'> <caption><b>Essential / Advanced plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class='role-setting'> <caption><b>Professional / Enterprise plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <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> <br> Read more about visibility groups <a href='https://support.pipedrive.com/en/article/visibility-groups'>here</a>."
},
"setting_key": {
"enum": [
"deal_default_visibility",
"lead_default_visibility",
"org_default_visibility",
"person_default_visibility",
"product_default_visibility"
],
"type": "string"
}
}
}
RolesAddOrUpdateSettingResponse
{
"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 role"
},
"deal_default_visibility": {
"enum": [
1,
3,
5,
7
],
"type": "number",
"description": "The setting"
}
},
"description": "The response data"
}
}
}
],
"title": "addOrUpdateRoleSettingResponse200"
}
RolesAssignUserRequest
{
"type": "object",
"title": "addRoleAssignmentRequest",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"description": "The ID of the user"
}
}
}
RolesAssignUserResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"role_id": {
"type": "integer",
"description": "The ID of the role the user was added to"
},
"user_id": {
"type": "integer",
"description": "The ID of the user that was added to the role"
}
},
"description": "The response data"
}
}
}
],
"title": "addRoleAssignmentResponse200"
}
RolesCreateRoleRequest
{
"type": "object",
"title": "addRoleRequest",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the role"
},
"parent_role_id": {
"type": "integer",
"description": "The ID of the parent role"
}
},
"description": "The details of the role"
}
RolesCreateRoleResponse
{
"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": {
"allOf": [
{
"type": "integer"
}
],
"description": "The ID of the created role"
}
},
"description": "The response data"
}
}
}
],
"title": "addRoleResponse200"
}
RolesGetAllRolesResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"allOf": [
{
"type": "object",
"title": "baseRoleRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the role"
},
"parent_role_id": {
"type": "integer",
"description": "The ID of the parent role"
}
},
"description": "The details of the role"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the role"
},
"active_flag": {
"type": "boolean",
"description": "Whether the role is active or not"
},
"sub_role_count": {
"type": "string",
"description": "The number of sub-roles"
},
"assignment_count": {
"type": "string",
"description": "The number of users assigned to this role"
}
}
}
],
"title": "subRole",
"description": "The details of the sub-role"
},
{
"type": "object",
"properties": {
"level": {
"type": "integer",
"description": "The level of role in the role hierarchy"
}
}
}
],
"title": "fullRole"
},
"description": "The array of roles"
},
"additional_data": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Items shown per page"
},
"start": {
"type": "integer",
"description": "Pagination start"
},
"more_items_in_collection": {
"type": "boolean",
"description": "Whether there are more list items in the collection than displayed"
}
},
"description": "The pagination details in the role list"
}
},
"description": "The additional data in the role list"
}
}
}
],
"title": "getRolesResponse200"
}
RolesGetOneRoleResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"type": "object",
"title": "baseRoleRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the role"
},
"parent_role_id": {
"type": "integer",
"description": "The ID of the parent role"
}
},
"description": "The details of the role"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the role"
},
"active_flag": {
"type": "boolean",
"description": "Whether the role is active or not"
},
"sub_role_count": {
"type": "string",
"description": "The number of sub-roles"
},
"assignment_count": {
"type": "string",
"description": "The number of users assigned to this role"
}
}
}
],
"title": "subRole",
"description": "The details of the sub-role"
},
"additional_data": {
"type": "object",
"properties": {
"settings": {
"type": "object",
"properties": {
"org_access_level": {
"type": "number",
"description": "The access level of the organizations for the role (only for default role)"
},
"deal_access_level": {
"type": "number",
"description": "The access level of the deals for the role (only for default role)"
},
"person_access_level": {
"type": "number",
"description": "The access level of the people for the role (only for default role)"
},
"product_access_level": {
"type": "number",
"description": "The access level of the products for the role (only for default role)"
},
"org_default_visibility": {
"type": "number",
"description": "The default visibility level of the organizations for the role"
},
"deal_default_visibility": {
"type": "number",
"description": "The default visibility level of the deals for the role"
},
"lead_default_visibility": {
"type": "number",
"description": "The default visibility level of the leads for the role"
},
"person_default_visibility": {
"type": "number",
"description": "The default visibility level of the people for the role"
},
"product_default_visibility": {
"type": "number",
"description": "The default visibility level of the products for the role"
}
},
"description": "The settings for the role"
}
},
"description": "The additional data in the role"
}
}
}
],
"title": "getRoleResponse200"
}
RolesGetRoleSettingsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"org_access_level": {
"type": "number",
"description": "The access level of the organizations for the role (only for default role)"
},
"deal_access_level": {
"type": "number",
"description": "The access level of the deals for the role (only for default role)"
},
"person_access_level": {
"type": "number",
"description": "The access level of the people for the role (only for default role)"
},
"product_access_level": {
"type": "number",
"description": "The access level of the products for the role (only for default role)"
},
"org_default_visibility": {
"type": "number",
"description": "The default visibility level of the organizations for the role"
},
"deal_default_visibility": {
"type": "number",
"description": "The default visibility level of the deals for the role"
},
"lead_default_visibility": {
"type": "number",
"description": "The default visibility level of the leads for the role"
},
"person_default_visibility": {
"type": "number",
"description": "The default visibility level of the people for the role"
},
"product_default_visibility": {
"type": "number",
"description": "The default visibility level of the products for the role"
}
},
"description": "The settings for the role"
}
}
}
],
"title": "getRoleSettingsResponse200"
}
RolesListPipelineVisibilityResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"visible": {
"type": "boolean",
"description": "Whether visible or hidden pipeline ids were returned"
},
"pipeline_ids": {
"type": "array",
"items": {
"type": "number",
"description": "The ID of the pipeline"
},
"description": "Either visible or hidden pipeline ids"
}
},
"description": "The response data"
}
}
}
],
"title": "getRolePipelines200"
}
RolesListRoleAssignmentsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"title": "baseRoleRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the role"
},
"parent_role_id": {
"type": "integer",
"description": "The ID of the parent role"
}
},
"description": "The details of the role"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The assignment type"
},
"role_id": {
"type": "integer",
"description": "The role ID"
},
"user_id": {
"type": "integer",
"description": "The user ID"
},
"active_flag": {
"type": "boolean",
"description": "Whether the role is active or not"
}
}
}
],
"title": "roleAssignment",
"description": "The assignment data of the role"
},
"description": "The role assignments"
},
"additional_data": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Items shown per page"
},
"start": {
"type": "integer",
"description": "Pagination start"
},
"more_items_in_collection": {
"type": "boolean",
"description": "Whether there are more list items in the collection than displayed"
}
},
"description": "The pagination details in the role list"
}
},
"description": "The additional data in the role list"
}
}
}
],
"title": "getUserRoleAssignmentsResponse200"
}
RolesMarkAsDeletedResponse
{
"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": {
"allOf": [
{
"type": "integer"
}
],
"description": "The ID of the deleted role"
}
},
"description": "The response data"
}
}
}
],
"title": "deleteRoleResponse200"
}