Pipedrive Recents API

openapi: 3.0.1
info:
  title: Pipedrive API v1 Activities Recents API
  version: 1.0.0
  description: 'Activities are appointments/tasks/events on a calendar that can be associated with a deal, a lead, a person and an organization. Activities can be of different type (such as call, meeting, lunch or a custom type - see ActivityTypes object) and can be assigned to a particular user. Note that activities can also be created without a specific date/time.

    '
servers:
- url: https://api.pipedrive.com/v1
tags:
- name: Recents
  description: 'Recent changes across all item types in Pipedrive (deals, persons, etc).

    '
paths:
  /recents:
    get:
      summary: Get recents
      description: Returns data about all recent changes occurred after the given timestamp.
      x-token-cost: 20
      operationId: getRecents
      tags:
      - Recents
      security:
      - api_key: []
      - oauth2:
        - recents:read
        - search:read
      parameters:
      - in: query
        name: since_timestamp
        required: true
        schema:
          type: string
        description: 'The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS.'
      - in: query
        name: items
        schema:
          type: string
          enum:
          - activity
          - activityType
          - deal
          - file
          - filter
          - note
          - person
          - organization
          - pipeline
          - product
          - stage
          - user
        description: Multiple selection of item types to include in the query (optional)
      - in: query
        name: start
        description: Pagination start
        schema:
          type: integer
          default: 0
      - in: query
        name: limit
        description: Items shown per page
        schema:
          type: integer
      responses:
        '200':
          description: List of items changed since "since_timestamp"
          content:
            application/json:
              schema:
                title: GetRecentsResponse
                type: object
                properties:
                  success:
                    type: boolean
                    description: If the response is successful or not
                  data:
                    type: array
                    title: RecentsData
                    items:
                      anyOf:
                      - type: object
                        properties:
                          item:
                            type: string
                            enum:
                            - activity
                          id:
                            type: integer
                          data:
                            title: Activity
                            allOf:
                            - type: object
                              properties:
                                due_date:
                                  description: 'The due date of the activity. Format: YYYY-MM-DD'
                                  type: string
                                  format: date
                                due_time:
                                  description: 'The due time of the activity in UTC. Format: HH:MM'
                                  type: string
                                duration:
                                  description: 'The duration of the activity. Format: HH:MM'
                                  type: string
                                deal_id:
                                  description: The ID of the deal this activity is associated with
                                  type: integer
                                lead_id:
                                  description: The ID of the lead in the UUID format this activity is associated with
                                  type: string
                                  format: uuid
                                  nullable: true
                                person_id:
                                  description: The ID of the person this activity is associated with
                                  type: integer
                                project_id:
                                  description: The ID of the project this activity is associated with
                                  type: integer
                                  nullable: true
                                org_id:
                                  description: The ID of the organization this activity is associated with
                                  type: integer
                                location:
                                  description: The address of the activity.
                                  type: string
                                public_description:
                                  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: string
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  description: The ID of the activity, generated when the activity was created
                                note:
                                  type: string
                                  description: The note of the activity (HTML format)
                                done:
                                  type: boolean
                                  description: Whether the activity is done or not
                                subject:
                                  description: The subject of the activity
                                  type: string
                                type:
                                  description: The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes.
                                  type: string
                                user_id:
                                  description: The ID of the user whom the activity is assigned to
                                  type: integer
                                participants:
                                  description: List of multiple persons (participants) this activity is associated with
                                  type: array
                                  nullable: true
                                  items:
                                    type: object
                                busy_flag:
                                  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.
                                  type: boolean
                                attendees:
                                  description: The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address.
                                  type: array
                                  nullable: true
                                  items:
                                    type: object
                                company_id:
                                  type: integer
                                  description: The user's company ID
                                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.
                                reference_id:
                                  type: integer
                                  description: Together with the `reference_type`, gives the ID of the other object
                                conference_meeting_client:
                                  type: string
                                  description: The ID of the Marketplace app, which is connected to this activity
                                conference_meeting_url:
                                  type: string
                                  description: The link to join the meeting which is associated with this activity
                                conference_meeting_id:
                                  type: string
                                  description: The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity
                                add_time:
                                  type: string
                                  description: 'The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS.'
                                marked_as_done_time:
                                  type: string
                                  description: 'The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS.'
                                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
                                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
                                notification_language_id:
                                  type: integer
                                  description: The ID of the language the notifications are sent in
                                active_flag:
                                  type: boolean
                                  description: Whether the activity is active or not
                                update_time:
                                  type: string
                                  description: 'The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS.'
                                update_user_id:
                                  description: The ID of the user who was the last to update this activity
                                  type: integer
                                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.
                                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.
                                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.
                                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)
                                source_timezone:
                                  type: string
                                  description: The timezone the activity was created in an external calendar
                                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"'
                                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.
                                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
                                series:
                                  description: 'The list of recurring activity instances. It is in a structure as follows: `[{due_date: "2020-06-24", due_time: "10:00:00"}]`'
                                  type: array
                                  items:
                                    type: object
                                created_by_user_id:
                                  description: The ID of the user who created the activity
                                  type: integer
                                location_subpremise:
                                  type: string
                                  description: A subfield of the location field. Indicates apartment/suite number.
                                location_street_number:
                                  type: string
                                  description: A subfield of the location field. Indicates house number.
                                location_route:
                                  type: string
                                  description: A subfield of the location field. Indicates street name.
                                location_sublocality:
                                  type: string
                                  description: A subfield of the location field. Indicates district/sublocality.
                                location_locality:
                                  type: string
                                  description: A subfield of the location field. Indicates city/town/village/locality.
                                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.
                                location_country:
                                  type: string
                                  description: A subfield of the location field. Indicates country.
                                location_postal_code:
                                  type: string
                                  description: A subfield of the location field. Indicates ZIP/postal code.
                                location_formatted_address:
                                  type: string
                                  description: A subfield of the location field. Indicates full/combined address.
                                org_name:
                                  description: The name of the organization this activity is associated with
                                  type: string
                                person_name:
                                  description: The name of the person this activity is associated with
                                  type: string
                                deal_title:
                                  description: The name of the deal this activity is associated with
                                  type: string
                                owner_name:
                                  description: The name of the user this activity is owned by
                                  type: string
                                person_dropbox_bcc:
                                  type: string
                                  description: The BCC email address of the person
                                deal_dropbox_bcc:
                                  type: string
                                  description: The BCC email address of the deal
                                assigned_to_user_id:
                                  description: The ID of the user to whom the activity is assigned to. Equal to `user_id`.
                                  type: integer
                                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.
                      - type: object
                        properties:
                          item:
                            type: string
                            enum:
                            - activityType
                          id:
                            type: integer
                          data:
                            type: object
                            title: ActivityType
                            properties:
                              id:
                                type: integer
                                description: The ID of the activity type
                              name:
                                type: string
                                description: The name of the activity type
                              icon_key:
                                type: string
                                description: Icon graphic to use for representing this activity type
                                enum:
                                - task
                                - email
                                - meeting
                                - deadline
                                - call
                                - lunch
                                - calendar
                                - downarrow
                                - document
                                - smartphone
                                - camera
                                - scissors
                                - cogs
                                - bubble
                                - uparrow
                                - checkbox
                                - signpost
                                - shuffle
                                - addressbook
                                - linegraph
                                - picture
                                - car
                                - world
                                - search
                                - clip
                                - sound
                                - brush
                                - key
                                - padlock
                                - pricetag
                                - suitcase
                                - finish
                                - plane
                                - loop
                                - wifi
                                - truck
                                - cart
                                - bulb
                                - bell
                                - presentation
                              color:
                                type: string
                                description: A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)
                              order_nr:
                                type: integer
                                description: An order number for the activity type. Order numbers should be used to order the types in the activity type selections.
                              key_string:
                                type: string
                                description: A string that is generated by the API based on the given name of the activity type upon creation
                              active_flag:
                                type: boolean
                                description: The active flag of the activity type
                              is_custom_flag:
                                type: boolean
                                description: Whether the activity type is a custom one or not
                              add_time:
                                type: string
                                format: date-time
                                description: The creation time of the activity type
                              update_time:
                                type: string
                                format: date-time
                                description: The update time of the activity type
                      - type: object
                        properties:
                          item:
                            type: string
                            enum:
                            - deal
                          id:
                            type: integer
                          data:
                            title: DealStrict
                            allOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  description: The ID of the deal
                                creator_user_id:
                                  type: integer
                                  description: The ID of the deal creator
                                user_id:
                                  type: integer
                                  description: The ID of the user
                                person_id:
                                  type: integer
                                  description: The ID of the person associated with the deal
                                org_id:
                                  type: integer
                                  description: The ID of the organization associated with the deal
                            - title: baseDeal
                              type: object
                              properties:
                                stage_id:
                                  type: integer
                                  description: The ID of the deal stage
                                title:
                                  type: string
                                  description: The title of the deal
                                value:
                                  type: number
                                  description: The value of the deal
                                currency:
                                  type: string
                                  description: The currency associated with the deal
                                add_time:
                                  type: string
                                  description: The creation date and time of the deal
                                update_time:
                                  type: string
                                  description: The last updated date and time of the deal
                                stage_change_time:
                                  type: string
                                  description: The last updated date and time of the deal stage
                                active:
                                  type: boolean
                                  description: Whether the deal is active or not
                                deleted:
                                  type: boolean
                                  description: Whether the deal is deleted or not
                                is_archived:
                                  type: boolean
                                  description: Whether the deal is archived or not
                                status:
                                  type: string
                                  description: The status of the deal
                                probability:
                                  type: number
                                  nullable: true
                                  description: The success probability percentage of 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
                                next_activity_id:
                                  type: integer
                                  nullable: true
                                  description: The ID of the next activity associated with the deal
                                last_activity_id:
                                  type: integer
                                  nullable: true
                                  description: The ID of the last activity associated with the deal
                                last_activity_date:
                                  type: string
                                  nullable: true
                                  description: The date of the last activity associated with the deal
                                lost_reason:
                                  type: string
                                  nullable: true
                                  description: The reason for losing the deal
                                visible_to:
                                  type: string
                                  description: The visibility of the deal
                                close_time:
                                  type: string
                                  nullable: true
                                  description: The date and time of closing the deal
                                pipeline_id:
                                  type: integer
                                  description: The ID of the pipeline associated with the deal
                                won_time:
                                  type: string
                                  description: The date and time of changing the deal status as won
                                first_won_time:
                                  type: string
                                  description: The date and time of the first time changing the deal status as won
                                lost_time:
                                  type: string
                                  description: The date and time of changing the deal status as lost
                                products_count:
                                  type: integer
                                  description: The number of products associated with the deal
                                files_count:
                                  type: integer
                                  description: The number of files associated with the deal
                                notes_count:
                                  type: integer
                                  description: The number of notes associated with the deal
                                followers_count:
                                  type: integer
                                  description: The number of followers associated with the deal
                                email_messages_count:
                                  type: integer
                                  description: The number of emails associated with the deal
                                activities_count:
                                  type: integer
                                  description: The number of activities associated with the deal
                                done_activities_count:
                                  type: integer
                                  description: The number of completed activities associated with the deal
                                undone_activities_count:
                                  type: integer
                                  description: The number of incomplete activities 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
                                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
                                label:
                                  type: string
                                  description: The label or multiple labels assigned to the deal
                                stage_order_nr:
                                  type: integer
                                  description: The order number of the deal stage associated with the deal
                                person_name:
                                  type: string
                                  description: The name of the person associated with the deal
                                org_name:
                                  type: string
                                  description: The name of the organization associated with the deal
                                next_activity_subject:
                                  type: string
                                  description: The subject of the next activity associated with the deal
                                next_activity_type:
                                  type: string
                                  description: The type of the next activity associated with the deal
                                next_activity_duration:
                                  type: string
                                  description: The duration of the next activity associated with the deal
                                next_activity_note:
                                  type: string
                                  description: The note of the next activity associated with the deal
                                formatted_value:
                                  type: string
                                  description: The deal value formatted with selected currency. E.g. US$500
                                weighted_value:
                                  type: number
                                  description: Probability times deal value. Probability can either be deal probability or if not set, then stage probability.
                                formatted_weighted_value:
                                  type: string
                                  description: The weighted_value formatted with selected currency. E.g. US$500
                                weighted_value_currency:
                                  type: string
                                  description: The currency associated with the deal
                                rotten_time:
                                  type: string
                                  nullable: true
                                  description: The date and time of changing the deal status as rotten
                                owner_name:
                                  type: string
                                  descri

# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pipedrive/refs/heads/main/openapi/pipedrive-recents-api-openapi.yml