Back to Pipedrive OauthList updates about a deal
Lists updates about a deal.
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: integer
description: The ID of the deal
start:
type: integer
default: 0
description: Pagination start
limit:
type: integer
description: Items shown per page
all_changes:
type: string
description: >-
Whether to show custom field updates or not. 1 = Include custom field
changes. If omitted returns changes without custom field updates.
items:
type: string
description: >-
A comma-separated string for filtering out item specific updates.
(Possible values - call, activity, plannedActivity, change, note,
deal, file, dealChange, personChange, organizationChange, follower,
dealFollower, personFollower, organizationFollower, participant,
comment, mailMessage, mailMessageWithAttachment, invoice, document,
marketing_campaign_stat, marketing_status_change)
required:
- id
Output
title: getDealUpdatesResponse200
type: object
properties:
success:
type: boolean
description: If the response is successful or not
data:
type: array
items:
type: object
properties:
object:
type: string
description: >-
The type of the deal update. (Possible object types - dealChange,
note, activity, mailMessage, invoice, document, file)
timestamp:
type: string
description: The creation date and time of the update
data:
type: object
description: The data related to the update
additional_data:
description: The additional data of the list
type: object
properties:
start:
type: integer
description: Pagination start
limit:
type: integer
description: Items shown per page
more_items_in_collection:
type: boolean
description: If there are more list items in the collection than displayed or not
related_objects:
type: object
properties:
deal:
type: object
properties:
DEAL_ID:
type: object
description: The ID of the deal which is associated with the item
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
status:
type: string
description: The status of the deal associated with the item
value:
type: number
description: The value of the deal that is 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
organization:
type: object
properties:
ORGANIZATION_ID:
type: object
description: The ID of the organization associated with the item
properties:
id:
type: integer
description: The ID of the organization associated with the item
name:
type: string
description: The name of the organization associated with the item
people_count:
type: integer
description: >-
The number of people connected with the organization that is
associated with the item
owner_id:
type: integer
description: >-
The ID of the owner of the organization that is 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
user:
type: object
properties:
USER_ID:
type: object
title: userDataWithId
description: The ID of the user
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
person:
type: object
properties:
PERSON_ID:
type: object
description: The ID of the person associated with the item
properties:
active_flag:
type: boolean
description: Whether the associated person is active or not
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
description: The emails of the person associated with the item
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
phone:
type: array
description: The phone numbers of the person associated with the item
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
owner_id:
type: integer
description: >-
The ID of the owner of the person that is associated with the
item