PersonFieldsUpdateFieldRequest
{
"type": "object",
"title": "updateFieldRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the field"
},
"options": {
"type": "array",
"items": {
"type": "object"
},
"description": "When `field_type` is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example: `[{\"id\":123,\"label\":\"Existing Item\"},{\"label\":\"New Item\"}]`"
},
"add_visible_flag": {
"type": "boolean",
"default": true,
"description": "Whether the field is available in 'add new' modal or not (both in web and mobile app)"
}
}
}
PersonFieldsUpdateFieldResponse
{
"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 field. Value is `null` in case of subfields."
},
"key": {
"type": "string",
"description": "The key of the field. For custom fields this is generated upon creation."
},
"name": {
"type": "string",
"description": "The name of the field"
},
"options": {
"type": "array",
"items": {
"type": "object"
},
"nullable": true,
"description": "The options of the field. When there are no options, `null` is returned."
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The creation time of the field"
},
"order_nr": {
"type": "integer",
"description": "The order number of the field"
},
"edit_flag": {
"type": "boolean",
"description": "The edit flag of the field"
},
"subfields": {
"type": "array",
"items": {
"type": "object"
},
"description": "The subfields of the field. Only present when the field has subfields."
},
"field_type": {
"allOf": [
{
"enum": [
"address",
"date",
"daterange",
"double",
"enum",
"monetary",
"org",
"people",
"phone",
"set",
"text",
"time",
"timerange",
"user",
"varchar",
"varchar_auto",
"visible_to"
],
"type": "string",
"description": "The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`address`</td><td>Address field (has multiple subfields, autocompleted by Google Maps)</td></tr><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td></tr><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td></tr><tr><td>`double`</td><td>Numeric value</td></tr><tr><td>`enum`</td><td>Options field with a single possible chosen option</td></tr><tr></tr><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td></tr><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td></tr><tr><td>`people`</td><td>Person field (contains a person ID which is stored on the same account)</td></tr><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td></tr><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td></tr><tr><td>`text`</td><td>Long text (up to 65k characters)</td></tr><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td></tr><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td></tr><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td></tr><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td></tr><tr><td>`visible_to`</td><td>System field that keeps item's visibility setting</td></tr></table>"
}
]
},
"active_flag": {
"type": "boolean",
"description": "The active flag of the field"
},
"is_subfield": {
"type": "boolean",
"description": "Whether or not the field is a subfield of another field. Only present if field is subfield."
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The update time of the field"
},
"sortable_flag": {
"type": "boolean",
"description": "Whether or not items can be sorted by this field"
},
"important_flag": {
"type": "boolean",
"description": "Not used"
},
"mandatory_flag": {
"type": "boolean",
"description": "Whether or not the field is mandatory"
},
"options_deleted": {
"type": "array",
"items": {
"type": "object"
},
"description": "The deleted options of the field. Only present when there is at least 1 deleted option."
},
"searchable_flag": {
"type": "boolean",
"description": "Whether or not items can be searched by this field"
},
"add_visible_flag": {
"type": "boolean",
"description": "Not used"
},
"bulk_edit_allowed": {
"type": "boolean",
"description": "Whether or not the field of an item can be edited in bulk"
},
"filtering_allowed": {
"type": "boolean",
"description": "Whether or not items can be filtered by this field"
},
"index_visible_flag": {
"type": "boolean",
"description": "Not used"
},
"details_visible_flag": {
"type": "boolean",
"description": "Not used"
},
"last_updated_by_user_id": {
"type": "integer",
"description": "The ID of the user who created or most recently updated the field, only applicable for custom fields"
}
}
}
}
}
],
"title": "fieldResponse200"
}
PersonsAddFollowerRequest
{
"type": "object",
"title": "addPersonFollowerRequest",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"description": "The ID of the user"
}
}
}
PersonsAddFollowerResponse
{
"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 follower"
},
"user_id": {
"type": "integer",
"description": "The ID of the user who was added as a follower to a person"
},
"add_time": {
"type": "string",
"description": "The date and time when the follower was added to a person. Format: YYYY-MM-DD HH:MM:SS"
},
"person_id": {
"type": "integer",
"description": "The ID of the person to whom the follower was added"
}
}
}
}
}
],
"title": "addPersonFollowerResponse200"
}
PersonsAddPictureRequest
{
"type": "object",
"title": "addPersonPictureRequest",
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "One image supplied in the multipart/form-data encoding"
},
"crop_x": {
"type": "integer",
"description": "X coordinate to where start cropping form (in pixels)"
},
"crop_y": {
"type": "integer",
"description": "Y coordinate to where start cropping form (in pixels)"
},
"crop_width": {
"type": "integer",
"description": "The width of the cropping area (in pixels)"
},
"crop_height": {
"type": "integer",
"description": "The height of the cropping area (in pixels)"
}
}
}
PersonsAddPictureResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"PICTURE_ID": {
"type": "object",
"allOf": [
{
"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"
}
}
}
]
}
],
"description": "The ID of the picture"
}
},
"description": "The picture that is associated with the item"
}
}
}
],
"title": "addPersonPictureResponse200"
}
PersonsCreateNewPersonRequest
{
"allOf": [
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the person"
}
}
},
{
"type": "object",
"title": "basicPersonRequest",
"properties": {
"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": "The 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 ID of the label."
},
"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."
},
"org_id": {
"type": "integer",
"description": "The ID of the organization this person will belong to"
},
"add_time": {
"type": "string",
"description": "The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used."
},
"visible_to": {
"type": "string",
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "The visibility of the person. 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>"
},
"marketing_status": {
"allOf": [
{
"enum": [
"no_consent",
"unsubscribed",
"subscribed",
"archived"
],
"type": "string"
}
],
"description": "If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table>"
}
}
}
],
"title": "addPersonRequest"
}
PersonsCreateNewPersonResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"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": {
"allOf": [
{
"allOf": [
{
"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"
}
}
},
{
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "The ID of the organization"
}
}
}
],
"title": "relationshipOrganizationInfoItem"
},
{
"type": "object",
"properties": {
"active_flag": {
"type": "boolean",
"description": "Whether the associated organization is active or not"
}
}
}
],
"title": "relationshipOrganizationInfoItemWithActiveFlag"
},
"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"
}
}
},
{
"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"
}
}
}
],
"title": "personNameInfoWithOrgAndOwnerId"
},
{
"type": "object",
"allOf": [
{
"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"
},
{
"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"
}
],
"title": "personCountEmailDealAndActivityInfo"
}
],
"title": "additionalPersonInfo"
}
],
"title": "personItem"
},
"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"
}
}
}
}
}
}
}
],
"title": "addPersonResponse200"
}
PersonsDeleteFollowerResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deleted person"
}
}
}
}
}
],
"title": "deletePersonResponse200"
}
PersonsDeleteMultipleBulkResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of deleted persons IDs"
}
}
}
}
}
],
"title": "deletePersonsResponse200"
}
PersonsDeletePictureResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deleted person"
}
}
}
}
}
],
"title": "deletePersonResponse200"
}
PersonsGetAll403Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
PersonsGetAllResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"title": "personsCollectionResponseObject",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the person"
},
"name": {
"type": "string",
"description": "The name 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": "The 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",
"nullable": true,
"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."
},
"org_id": {
"type": "integer",
"description": "The ID of the organization related to the person"
},
"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"
},
"owner_id": {
"type": "integer",
"description": "The ID of the owner related to the person"
},
"picture_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the picture associated with the item"
},
"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"
},
"delete_time": {
"type": "string",
"nullable": true,
"description": "The date and time this person was deleted. Format: YYYY-MM-DD HH:MM:SS"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the person. Format: YYYY-MM-DD HH:MM:SS"
}
}
}
},
"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"
}
}
}
PersonsGetPersonDetailsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"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": {
"allOf": [
{
"allOf": [
{
"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"
}
}
},
{
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "The ID of the organization"
}
}
}
],
"title": "relationshipOrganizationInfoItem"
},
{
"type": "object",
"properties": {
"active_flag": {
"type": "boolean",
"description": "Whether the associated organization is active or not"
}
}
}
],
"title": "relationshipOrganizationInfoItemWithActiveFlag"
},
"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"
}
}
},
{
"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"
}
}
}
],
"title": "personNameInfoWithOrgAndOwnerId"
},
{
"type": "object",
"allOf": [
{
"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"
},
{
"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"
}
],
"title": "personCountEmailDealAndActivityInfo"
}
],
"title": "additionalPersonInfo"
}
],
"title": "personItem"
},
"additional_data": {
"type": "object",
"properties": {
"dropbox_email": {
"type": "string",
"description": "Dropbox email for the person"
}
}
},
"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"
}
}
},
"picture": {
"type": "object",
"properties": {
"PICTURE_ID": {
"type": "object",
"allOf": [
{
"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"
}
}
}
]
}
],
"description": "The ID of the picture"
}
},
"description": "The picture that is 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"
}
}
}
}
}
}
}
],
"title": "getPersonResponse200"
}
PersonsListActivitiesResponse
{
"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": {
"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"
},
"description": "The array of activities"
},
"additional_data": {
"allOf": [
{
"type": "object",
"properties": {
"activity_distribution": {
"type": "object",
"properties": {
"ASSIGNED_TO_USER_ID": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the user"
},
"share": {
"type": "integer",
"description": "The percentage of activities belongs to the user"
},
"activities": {
"type": "object",
"properties": {
"ACTIVITY_TYPE_NAME": {
"type": "integer",
"description": "The count of activities related to a specific type"
}
},
"description": "The count of activities related to the user grouped by activity type"
},
"activity_count": {
"type": "integer",
"description": "The overall count of activities for the user"
}
},
"description": "The ID of the user"
}
},
"description": "The distribution of activities related to the organization grouped by the user ID"
}
}
},
{
"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": "activityDistributionDataWithAdditionalData"
}
}
}
],
"title": "getAssociatedActivitiesResponse200"
}
PersonsListAllPersonsResponse
{
"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",
"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": {
"allOf": [
{
"allOf": [
{
"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"
}
}
},
{
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "The ID of the organization"
}
}
}
],
"title": "relationshipOrganizationInfoItem"
},
{
"type": "object",
"properties": {
"active_flag": {
"type": "boolean",
"description": "Whether the associated organization is active or not"
}
}
}
],
"title": "relationshipOrganizationInfoItemWithActiveFlag"
},
"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"
}
}
},
{
"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"
}
}
}
],
"title": "personNameInfoWithOrgAndOwnerId"
},
{
"type": "object",
"allOf": [
{
"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"
},
{
"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"
}
],
"title": "personCountEmailDealAndActivityInfo"
}
],
"title": "additionalPersonInfo"
}
],
"title": "personItem"
},
"description": "The array of persons"
},
"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"
}
}
},
"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"
}
}
},
"picture": {
"type": "object",
"properties": {
"PICTURE_ID": {
"type": "object",
"allOf": [
{
"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"
}
}
}
]
}
],
"description": "The ID of the picture"
}
},
"description": "The picture that is 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"
}
}
}
}
}
}
}
],
"title": "getPersonsResponse200"
}
PersonsListChangelogResponse
{
"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": {
"time": {
"type": "string",
"description": "The date and time of the change"
},
"field_key": {
"type": "string",
"description": "The key of the field that was changed"
},
"new_value": {
"type": "string",
"nullable": true,
"description": "The value of the field after the change"
},
"old_value": {
"type": "string",
"nullable": true,
"description": "The value of the field before the change"
},
"actor_user_id": {
"type": "integer",
"description": "The ID of the user who made the change"
},
"change_source": {
"type": "string",
"nullable": true,
"description": "The source of change, for example 'app', 'mobile', 'api', etc."
},
"is_bulk_update_flag": {
"type": "boolean",
"description": "Whether the change was made as part of a bulk update"
},
"change_source_user_agent": {
"type": "string",
"nullable": true,
"description": "The user agent from which the change was made"
}
}
}
},
"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"
}
}
}
],
"title": "getChangelogResponse200"
}
PersonsListDealsResponse
{
"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"
}
PersonsListFollowersResponse
{
"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"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal which the follower was added to"
},
"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"
}
}
},
"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": "getAssociatedFollowersResponse200"
}
PersonsListMailMessagesResponse
{
"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": {
"data": {
"allOf": [
{
"type": "object",
"properties": {
"cc": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail participant"
},
"name": {
"type": "string",
"description": "Name of the mail participant"
},
"email_address": {
"type": "string",
"description": "Mail address of the mail participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person to the mail message"
},
"linked_person_name": {
"type": "string",
"description": "Name of the linked person to the mail message"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message participant"
}
}
},
"description": "The array of mail message copies (object)"
},
"id": {
"type": "integer",
"description": "ID of the mail message."
},
"to": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail participant"
},
"name": {
"type": "string",
"description": "Name of the mail participant"
},
"email_address": {
"type": "string",
"description": "Mail address of the mail participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person to the mail message"
},
"linked_person_name": {
"type": "string",
"description": "Name of the linked person to the mail message"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message participant"
}
}
},
"description": "The array of mail message receiver (object)"
},
"bcc": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail participant"
},
"name": {
"type": "string",
"description": "Name of the mail participant"
},
"email_address": {
"type": "string",
"description": "Mail address of the mail participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person to the mail message"
},
"linked_person_name": {
"type": "string",
"description": "Name of the linked person to the mail message"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message participant"
}
}
},
"description": "The array of mail message blind copies (object)"
},
"from": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail participant"
},
"name": {
"type": "string",
"description": "Name of the mail participant"
},
"email_address": {
"type": "string",
"description": "Mail address of the mail participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person to the mail message"
},
"linked_person_name": {
"type": "string",
"description": "Name of the linked person to the mail message"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message participant"
}
}
},
"description": "The array of mail message sender (object)"
},
"draft": {
"type": "string",
"description": "If the mail message has a draft status then the value is the mail message object as JSON formatted string, otherwise `null`."
},
"snippet": {
"type": "string",
"description": "The snippet of mail message. Snippet length is up to 225 characters."
},
"subject": {
"type": "string",
"description": "The subject of mail message"
},
"user_id": {
"type": "integer",
"description": "ID of the user whom mail message will be assigned to"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The insertion into the database time of the mail message"
},
"body_url": {
"type": "string",
"description": "The mail message body URL"
},
"read_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message is read or not by the user"
},
"sent_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has been sent or not"
},
"account_id": {
"type": "string",
"description": "The connection account ID"
},
"draft_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message is a draft or not"
},
"synced_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message is synced with the provider or not"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The updating time in the database of the mail message"
},
"deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message is deleted or not"
},
"message_time": {
"type": "string",
"format": "date-time",
"description": "Creation or receival time of the mail message"
},
"has_body_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has a body or not"
},
"mail_thread_id": {
"type": "integer",
"description": "ID of the mail message thread"
},
"smart_bcc_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has been created by Smart Email BCC feature or not"
},
"has_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has an attachment or not"
},
"mail_tracking_status": {
"enum": [
"opened",
"not opened"
],
"type": "string",
"nullable": true,
"description": "The status of tracking mail message. Value is `null` if tracking is not enabled."
},
"sent_from_pipedrive_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has been sent from Pipedrive app or not"
},
"has_real_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has an attachment (which is not inline) or not"
},
"has_inline_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has an inline attachment or not"
},
"mail_link_tracking_enabled_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the link tracking in mail message body is enabled."
}
}
},
{
"type": "object",
"properties": {
"nylas_id": {
"type": "string",
"description": "The Mail Message ID assigned by the sync provider"
},
"item_type": {
"type": "string",
"description": "The type of the data item"
},
"s3_bucket": {
"type": "string",
"description": "The name of the S3 bucket"
},
"timestamp": {
"type": "string",
"description": "The add date and time of the Mail Message"
},
"company_id": {
"type": "integer",
"description": "The ID of the company"
},
"template_id": {
"type": "integer",
"description": "The ID of the mail template"
},
"mua_message_id": {
"type": "string",
"description": "The Mail Message ID assigned by the mail user agent"
},
"s3_bucket_path": {
"type": "string",
"description": "The path of the S3 bucket"
},
"external_deleted_flag": {
"type": "boolean",
"description": "If the Mail Message has been deleted on the provider side or not"
}
}
}
],
"title": "mailMessageItemForList"
},
"object": {
"type": "string",
"description": "The type of the data item"
},
"timestamp": {
"type": "string",
"description": "The date and time when the item was created"
}
}
},
"description": "The array of mail messages"
},
"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": "getAssociatedMailMessagesResponse200"
}
PersonsListPermittedUsersResponse
{
"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": "number"
},
"description": "The list of permitted user IDs"
}
}
}
],
"title": "listPermittedUsersResponse200"
}
PersonsListPersonFilesResponse
{
"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"
},
"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"
},
"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"
}
PersonsListProductsResponse
{
"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": {
"DEAL_ID": {
"type": "object",
"properties": {
"deal": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deal"
},
"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"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization associated with the deal"
},
"status": {
"type": "string",
"description": "The status of the deal"
},
"deleted": {
"type": "boolean",
"description": "Whether the deal is deleted or not"
},
"user_id": {
"type": "integer",
"description": "The ID of the user"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the deal"
},
"currency": {
"type": "string",
"description": "The currency 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"
},
"person_id": {
"type": "integer",
"description": "The ID of the person associated with the deal"
},
"close_time": {
"type": "string",
"nullable": true,
"description": "The date and time of closing the deal"
},
"company_id": {
"type": "integer",
"description": "The ID of the company"
},
"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"
},
"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"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the deal"
},
"first_add_time": {
"type": "string",
"description": "The first creation date and time of the deal"
},
"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"
},
"creator_user_id": {
"type": "integer",
"description": "The ID of the deal creator"
},
"followers_count": {
"type": "integer",
"description": "The number of followers associated with the deal"
},
"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_time": {
"type": "string",
"description": "The time 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"
},
"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"
}
}
},
"product": {
"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"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal"
},
"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, the authorized user ID will be used."
},
"company_id": {
"type": "integer",
"description": "The ID of the company"
},
"first_char": {
"type": "string",
"description": "The first letter of the product name"
},
"selectable": {
"type": "boolean",
"default": true,
"description": "Whether this product can be selected in deals or not"
},
"visible_to": {
"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.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner & followers (private)</td></tr><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>"
},
"active_flag": {
"type": "boolean",
"default": true,
"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"
}
}
}
}
}
}
},
"description": "The array of deal products"
},
"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": "getPersonProductsResponse200"
}
PersonsListUpdatesAboutResponse
{
"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": {
"data": {
"type": "object",
"description": "The data related to the update"
},
"object": {
"type": "string",
"description": "The type of the person update. (Possible object types - personChange, note, activity, file)"
},
"timestamp": {
"type": "string",
"description": "The creation date and time of the update"
}
}
}
},
"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": {
"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"
}
}
},
"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"
}
}
}
}
}
}
}
],
"title": "getAssociatedPersonUpdatesResponse200"
}
PersonsMarkAsDeletedResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deleted person"
}
}
}
}
}
],
"title": "deletePersonResponse200"
}
PersonsMergeTwoRequest
{
"type": "object",
"title": "mergePersonsRequest",
"required": [
"merge_with_id"
],
"properties": {
"merge_with_id": {
"type": "integer",
"description": "The ID of the person that will not be overwritten. This person’s data will be prioritized in case of conflict with the other person."
}
}
}
PersonsMergeTwoResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"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"
}
}
}
],
"title": "mergePersonsResponse200"
}
PersonsSearchByCriteriaResponse
{
"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 person"
},
"name": {
"type": "string",
"description": "The name of the person"
},
"type": {
"type": "string",
"description": "The type of the item"
},
"notes": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of notes"
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the owner of the person"
}
}
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of email addresses"
},
"phones": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of phone numbers"
},
"visible_to": {
"type": "integer",
"description": "The visibility of the person"
},
"organization": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the organization the person is associated with"
},
"name": {
"type": "string",
"description": "The name of the organization the person is associated with"
}
}
},
"custom_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom fields"
}
}
},
"result_score": {
"type": "number",
"description": "Search result relevancy"
}
}
},
"description": "The array of 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": "searchPersonsResponse200"
}
PersonsUpdatePropertiesRequest
{
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the person"
}
}
},
{
"type": "object",
"title": "basicPersonRequest",
"properties": {
"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": "The 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 ID of the label."
},
"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."
},
"org_id": {
"type": "integer",
"description": "The ID of the organization this person will belong to"
},
"add_time": {
"type": "string",
"description": "The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used."
},
"visible_to": {
"type": "string",
"allOf": [
{
"enum": [
"1",
"3",
"5",
"7"
],
"type": "string"
}
],
"description": "The visibility of the person. 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>"
},
"marketing_status": {
"allOf": [
{
"enum": [
"no_consent",
"unsubscribed",
"subscribed",
"archived"
],
"type": "string"
}
],
"description": "If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table>"
}
}
}
],
"title": "updatePersonRequest"
}
PersonsUpdatePropertiesResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"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": {
"allOf": [
{
"allOf": [
{
"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"
}
}
},
{
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "The ID of the organization"
}
}
}
],
"title": "relationshipOrganizationInfoItem"
},
{
"type": "object",
"properties": {
"active_flag": {
"type": "boolean",
"description": "Whether the associated organization is active or not"
}
}
}
],
"title": "relationshipOrganizationInfoItemWithActiveFlag"
},
"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"
}
}
},
{
"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"
}
}
}
],
"title": "personNameInfoWithOrgAndOwnerId"
},
{
"type": "object",
"allOf": [
{
"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"
},
{
"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"
}
],
"title": "personCountEmailDealAndActivityInfo"
}
],
"title": "additionalPersonInfo"
}
],
"title": "personItem"
},
"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"
}
}
}
}
}
}
}
],
"title": "updatePersonResponse200"
}
PipelinesCreateNewPipelineRequest
{
"type": "object",
"title": "pipelineRequest",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the pipeline"
},
"active": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether this pipeline will be made inactive (hidden) or active"
},
"order_nr": {
"type": "integer",
"description": "Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline."
},
"deal_probability": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether deal probability is disabled or enabled for this pipeline"
}
}
}
PipelinesCreateNewPipelineResponse
{
"type": "object",
"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 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"
}
},
"description": "The pipeline object"
}
}
}
],
"title": "addPipelineResponse200"
}
PipelinesDeletePipelineResponse
{
"type": "object",
"title": "deletePipelineResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Deleted Pipeline ID"
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
PipelinesGetAllResponse
{
"type": "object",
"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",
"allOf": [
{
"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"
}
}
},
{
"type": "object",
"properties": {
"selected": {
"type": "boolean",
"description": "A boolean that shows if the pipeline is selected from a filter or not"
}
}
}
],
"title": "basePipelineWithSelectedFlag"
},
"description": "Pipelines array"
}
}
}
],
"title": "getPipelinesResponse200"
}
PipelinesGetConversionStatisticsResponse
{
"type": "object",
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"won_conversion": {
"type": "integer",
"description": "The won conversion"
},
"lost_conversion": {
"type": "integer",
"description": "The lost conversion"
},
"stage_conversions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"to_stage_id": {
"type": "integer",
"description": "The stage ID to where conversion ends"
},
"from_stage_id": {
"type": "integer",
"description": "The stage ID from where conversion starts"
},
"conversion_rate": {
"type": "integer",
"description": "The conversion rate"
}
}
},
"description": "The stage conversions"
}
},
"description": "The pipeline object"
}
}
}
],
"title": "getPipelineConversionStatisticsResponse200"
}
PipelinesGetMovementStatisticsResponse
{
"type": "object",
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"new_deals": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "The count of the deals"
},
"values": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "integer",
"description": "The value of the deals"
}
},
"description": "The values of the deals"
},
"deals_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of the deals that have been moved"
},
"formatted_values": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "string",
"description": "The formatted values of the deals"
}
},
"description": "The formatted values of the deals"
}
},
"description": "Deals summary"
},
"won_deals": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "The count of the deals"
},
"values": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "integer",
"description": "The value of the deals"
}
},
"description": "The values of the deals"
},
"deals_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of the deals that have been moved"
},
"formatted_values": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "string",
"description": "The formatted values of the deals"
}
},
"description": "The formatted values of the deals"
}
},
"description": "Deals summary"
},
"lost_deals": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "The count of the deals"
},
"values": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "integer",
"description": "The value of the deals"
}
},
"description": "The values of the deals"
},
"deals_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of the deals that have been moved"
},
"formatted_values": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "string",
"description": "The formatted values of the deals"
}
},
"description": "The formatted values of the deals"
}
},
"description": "Deals summary"
},
"deals_left_open": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "The count of the deals"
},
"values": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "integer",
"description": "The value of the deals"
}
},
"description": "The values of the deals"
},
"deals_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of the deals that have been moved"
},
"formatted_values": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "string",
"description": "The formatted values of the deals"
}
},
"description": "The formatted values of the deals"
}
},
"description": "Deals summary"
},
"average_age_in_days": {
"type": "object",
"properties": {
"by_stages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "The average deals age in specific stage"
},
"stage_id": {
"type": "integer",
"description": "The stage ID"
}
},
"description": "The moved deals average age by the stage"
},
"description": "The moved deals average age by stages"
},
"across_all_stages": {
"type": "integer",
"description": "The moved deals average age across all stages"
}
},
"description": "The moved deals average age in days"
},
"movements_between_stages": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "The count of the deals that have been moved between stages"
}
},
"description": "Movements between stages"
}
},
"description": "The pipeline object"
}
}
}
],
"title": "getPipelineMovementStatisticsResponse200"
}
PipelinesGetOnePipelineSummaryResponse
{
"type": "object",
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"allOf": [
{
"type": "object",
"allOf": [
{
"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"
}
}
},
{
"type": "object",
"properties": {
"selected": {
"type": "boolean",
"description": "A boolean that shows if the pipeline is selected from a filter or not"
}
}
}
],
"title": "basePipelineWithSelectedFlag"
},
{
"type": "object",
"properties": {
"deals_summary": {
"type": "object",
"properties": {
"per_stages": {
"type": "object",
"properties": {
"STAGE_ID": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Deals count per currency"
},
"value": {
"type": "integer",
"description": "Deals value per currency"
},
"weighted_value": {
"type": "integer",
"description": "Deals weighted value per currency"
},
"value_formatted": {
"type": "string",
"description": "Deals value formatted per currency"
},
"weighted_value_formatted": {
"type": "string",
"description": "Deals weighted value formatted per currency"
}
},
"description": "The currency summary. This parameter is dynamic and changes according to `currency_id` value."
}
},
"description": "The currency summaries per stage. This parameter is dynamic and changes according to `stage_id` value."
}
},
"description": "The stage objects containing deals currency information"
},
"total_count": {
"type": "integer",
"description": "Deals count"
},
"per_currency": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "integer",
"description": "Deals count per currency. This parameter is dynamic and changes according to `currency_id` value."
}
},
"description": "The currency count summary"
},
"per_currency_full": {
"type": "object",
"properties": {
"CURRENCY_ID": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Deals count per currency"
},
"value": {
"type": "integer",
"description": "Deals value per currency"
}
},
"description": "The currency summary. This parameter is dynamic and changes according to `currency_id` value."
}
},
"description": "Full currency summaries"
}
},
"description": "Deals summary"
}
}
}
],
"title": "pipelineDetails",
"description": "The pipeline object"
}
}
}
],
"title": "getPipelineResponse200"
}
PipelinesListDealsResponse
{
"type": "object",
"title": "getStageDealsResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"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"
},
"description": "The array of deals"
},
"success": {
"type": "boolean",
"description": "If the request was 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"
}
}
}
PipelinesUpdatePropertiesRequest
{
"type": "object",
"title": "pipelineRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the pipeline"
},
"active": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether this pipeline will be made inactive (hidden) or active"
},
"order_nr": {
"type": "integer",
"description": "Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline."
},
"deal_probability": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether deal probability is disabled or enabled for this pipeline"
}
}
}
PipelinesUpdatePropertiesResponse
{
"type": "object",
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"allOf": [
{
"type": "object",
"allOf": [
{
"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"
}
}
},
{
"type": "object",
"properties": {
"selected": {
"type": "boolean",
"description": "A boolean that shows if the pipeline is selected from a filter or not"
}
}
}
],
"title": "basePipelineWithSelectedFlag"
}
],
"description": "The pipeline object"
}
}
}
],
"title": "updatePipelineResponse200"
}
ProductFieldsAddNewFieldRequest
{
"type": "object",
"required": [
"name",
"field_type"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the field"
},
"options": {
"type": "array",
"items": {
"type": "object"
},
"description": "When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{\"label\":\"red\"}, {\"label\":\"blue\"}, {\"label\":\"lilac\"}]`"
},
"field_type": {
"enum": [
"varchar",
"varchar_auto",
"text",
"double",
"monetary",
"date",
"set",
"enum",
"user",
"org",
"people",
"phone",
"time",
"timerange",
"daterange",
"address"
],
"type": "string",
"description": "The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table>"
}
}
}
ProductFieldsAddNewFieldResponse
{
"type": "object",
"title": "getProductFieldResponse200",
"properties": {
"data": {
"allOf": [
{
"allOf": [
{
"type": "object",
"required": [
"name",
"field_type"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the field"
},
"options": {
"type": "array",
"items": {
"type": "object"
},
"description": "When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{\"label\":\"red\"}, {\"label\":\"blue\"}, {\"label\":\"lilac\"}]`"
},
"field_type": {
"enum": [
"varchar",
"varchar_auto",
"text",
"double",
"monetary",
"date",
"set",
"enum",
"user",
"org",
"people",
"phone",
"time",
"timerange",
"daterange",
"address"
],
"type": "string",
"description": "The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table>"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the product field"
},
"key": {
"type": "string",
"description": "The key of the product field"
},
"add_time": {
"type": "string",
"description": "The product field creation time. Format: YYYY-MM-DD HH:MM:SS"
},
"order_nr": {
"type": "integer",
"description": "The position (index) of the product field in the detail view"
},
"edit_flag": {
"type": "boolean",
"description": "Whether or not the product field name and metadata is editable"
},
"active_flag": {
"type": "boolean",
"description": "Whether or not the product field is currently active"
},
"update_time": {
"type": "string",
"description": "The product field last update time. Format: YYYY-MM-DD HH:MM:SS"
},
"sortable_flag": {
"type": "boolean",
"description": "Whether or not the product field is sortable"
},
"important_flag": {
"type": "boolean",
"description": "Whether or not the product field is marked as important"
},
"mandatory_flag": {
"type": "boolean",
"description": "Whether or not the product field is mandatory when creating products"
},
"searchable_flag": {
"type": "boolean",
"description": "Whether or not the product field is searchable"
},
"add_visible_flag": {
"type": "boolean",
"description": "Whether or not the product field is visible in the Add Product Modal"
},
"bulk_edit_allowed": {
"type": "boolean",
"description": "Whether or not the product field data can be edited"
},
"filtering_allowed": {
"type": "boolean",
"description": "Whether or not the product field value can be used when filtering searches"
},
"last_updated_by_user_id": {
"type": "integer",
"description": "The ID of the last user to update the product field"
}
}
}
],
"title": "productField"
}
],
"description": "All data for the product field"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
ProductFieldsDeleteMultipleBulkResponse
{
"type": "object",
"title": "deleteProductFieldsResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of all the IDs of the deleted product fields"
}
}
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
ProductFieldsGetAllFieldsResponse
{
"type": "object",
"title": "getProductFieldsResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"required": [
"name",
"field_type"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the field"
},
"options": {
"type": "array",
"items": {
"type": "object"
},
"description": "When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{\"label\":\"red\"}, {\"label\":\"blue\"}, {\"label\":\"lilac\"}]`"
},
"field_type": {
"enum": [
"varchar",
"varchar_auto",
"text",
"double",
"monetary",
"date",
"set",
"enum",
"user",
"org",
"people",
"phone",
"time",
"timerange",
"daterange",
"address"
],
"type": "string",
"description": "The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table>"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the product field"
},
"key": {
"type": "string",
"description": "The key of the product field"
},
"add_time": {
"type": "string",
"description": "The product field creation time. Format: YYYY-MM-DD HH:MM:SS"
},
"order_nr": {
"type": "integer",
"description": "The position (index) of the product field in the detail view"
},
"edit_flag": {
"type": "boolean",
"description": "Whether or not the product field name and metadata is editable"
},
"active_flag": {
"type": "boolean",
"description": "Whether or not the product field is currently active"
},
"update_time": {
"type": "string",
"description": "The product field last update time. Format: YYYY-MM-DD HH:MM:SS"
},
"sortable_flag": {
"type": "boolean",
"description": "Whether or not the product field is sortable"
},
"important_flag": {
"type": "boolean",
"description": "Whether or not the product field is marked as important"
},
"mandatory_flag": {
"type": "boolean",
"description": "Whether or not the product field is mandatory when creating products"
},
"searchable_flag": {
"type": "boolean",
"description": "Whether or not the product field is searchable"
},
"add_visible_flag": {
"type": "boolean",
"description": "Whether or not the product field is visible in the Add Product Modal"
},
"bulk_edit_allowed": {
"type": "boolean",
"description": "Whether or not the product field data can be edited"
},
"filtering_allowed": {
"type": "boolean",
"description": "Whether or not the product field value can be used when filtering searches"
},
"last_updated_by_user_id": {
"type": "integer",
"description": "The ID of the last user to update the product field"
}
}
}
],
"title": "productField"
},
"description": "Array containing data for all product fields"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
},
"additional_data": {
"type": "object",
"description": "Additional data for the product field, such as pagination"
}
}
}
ProductFieldsGetOneField410Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
ProductFieldsGetOneFieldResponse
{
"type": "object",
"title": "getProductFieldResponse200",
"properties": {
"data": {
"allOf": [
{
"allOf": [
{
"type": "object",
"required": [
"name",
"field_type"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the field"
},
"options": {
"type": "array",
"items": {
"type": "object"
},
"description": "When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{\"label\":\"red\"}, {\"label\":\"blue\"}, {\"label\":\"lilac\"}]`"
},
"field_type": {
"enum": [
"varchar",
"varchar_auto",
"text",
"double",
"monetary",
"date",
"set",
"enum",
"user",
"org",
"people",
"phone",
"time",
"timerange",
"daterange",
"address"
],
"type": "string",
"description": "The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table>"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the product field"
},
"key": {
"type": "string",
"description": "The key of the product field"
},
"add_time": {
"type": "string",
"description": "The product field creation time. Format: YYYY-MM-DD HH:MM:SS"
},
"order_nr": {
"type": "integer",
"description": "The position (index) of the product field in the detail view"
},
"edit_flag": {
"type": "boolean",
"description": "Whether or not the product field name and metadata is editable"
},
"active_flag": {
"type": "boolean",
"description": "Whether or not the product field is currently active"
},
"update_time": {
"type": "string",
"description": "The product field last update time. Format: YYYY-MM-DD HH:MM:SS"
},
"sortable_flag": {
"type": "boolean",
"description": "Whether or not the product field is sortable"
},
"important_flag": {
"type": "boolean",
"description": "Whether or not the product field is marked as important"
},
"mandatory_flag": {
"type": "boolean",
"description": "Whether or not the product field is mandatory when creating products"
},
"searchable_flag": {
"type": "boolean",
"description": "Whether or not the product field is searchable"
},
"add_visible_flag": {
"type": "boolean",
"description": "Whether or not the product field is visible in the Add Product Modal"
},
"bulk_edit_allowed": {
"type": "boolean",
"description": "Whether or not the product field data can be edited"
},
"filtering_allowed": {
"type": "boolean",
"description": "Whether or not the product field value can be used when filtering searches"
},
"last_updated_by_user_id": {
"type": "integer",
"description": "The ID of the last user to update the product field"
}
}
}
],
"title": "productField"
}
],
"description": "All data for the product field"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
ProductFieldsMarkAsDeleted410Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
ProductFieldsMarkAsDeletedResponse
{
"type": "object",
"title": "deleteProductFieldResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"type": "integer"
}
],
"description": "The ID of the deleted product field"
}
}
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
ProductFieldsUpdateFieldRequest
{
"type": "object",
"title": "UpdateProductFieldResponse200",
"properties": {
"name": {
"type": "string",
"description": "The name of the field"
},
"options": {
"type": "array",
"items": {
"type": "object"
},
"description": "When `field_type` is either set or enum, possible options on update must be supplied as an array of objects each containing id and label, for example: [{\"id\":1, \"label\":\"red\"},{\"id\":2, \"label\":\"blue\"},{\"id\":3, \"label\":\"lilac\"}]"
}
}
}
ProductFieldsUpdateFieldResponse
{
"type": "object",
"title": "getProductFieldResponse200",
"properties": {
"data": {
"allOf": [
{
"allOf": [
{
"type": "object",
"required": [
"name",
"field_type"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the field"
},
"options": {
"type": "array",
"items": {
"type": "object"
},
"description": "When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{\"label\":\"red\"}, {\"label\":\"blue\"}, {\"label\":\"lilac\"}]`"
},
"field_type": {
"enum": [
"varchar",
"varchar_auto",
"text",
"double",
"monetary",
"date",
"set",
"enum",
"user",
"org",
"people",
"phone",
"time",
"timerange",
"daterange",
"address"
],
"type": "string",
"description": "The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table>"
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the product field"
},
"key": {
"type": "string",
"description": "The key of the product field"
},
"add_time": {
"type": "string",
"description": "The product field creation time. Format: YYYY-MM-DD HH:MM:SS"
},
"order_nr": {
"type": "integer",
"description": "The position (index) of the product field in the detail view"
},
"edit_flag": {
"type": "boolean",
"description": "Whether or not the product field name and metadata is editable"
},
"active_flag": {
"type": "boolean",
"description": "Whether or not the product field is currently active"
},
"update_time": {
"type": "string",
"description": "The product field last update time. Format: YYYY-MM-DD HH:MM:SS"
},
"sortable_flag": {
"type": "boolean",
"description": "Whether or not the product field is sortable"
},
"important_flag": {
"type": "boolean",
"description": "Whether or not the product field is marked as important"
},
"mandatory_flag": {
"type": "boolean",
"description": "Whether or not the product field is mandatory when creating products"
},
"searchable_flag": {
"type": "boolean",
"description": "Whether or not the product field is searchable"
},
"add_visible_flag": {
"type": "boolean",
"description": "Whether or not the product field is visible in the Add Product Modal"
},
"bulk_edit_allowed": {
"type": "boolean",
"description": "Whether or not the product field data can be edited"
},
"filtering_allowed": {
"type": "boolean",
"description": "Whether or not the product field value can be used when filtering searches"
},
"last_updated_by_user_id": {
"type": "integer",
"description": "The ID of the last user to update the product field"
}
}
}
],
"title": "productField"
}
],
"description": "All data for the product field"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}