Activities

Activities are appointments/tasks/events on a calendar that can be associated with a Deal, 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.

Get all Activities assigned to a particular User

Copy link
Copy to clipboard
GET

/v1/activities

Returns all Activities assigned to a particular User.

Query parameters

user_id

integer

The ID of the User whose Activities will be fetched. If omitted, the User associated with the API token will be used. If 0, Activities for all company Users will be fetched based on the permission sets.

filter_id

integer

The ID of the Filter to use (will narrow down results if used together with user_id parameter)

type

string

Type of the Activity, can be one type or multiple types separated by a comma. This is in correlation with the key_string parameter of ActivityTypes.

limit

integer

For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.

start

integer

For pagination, the position that represents the first result for the page

start_date

string

Use the Activity due date where you wish to begin fetching Activities from. Insert due date in YYYY-MM-DD format.

Format

date

end_date

string

Use the Activity due date where you wish to stop fetching Activities from. Insert due date in YYYY-MM-DD format.

Format

date

done

number

Whether the Activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.

Values

0

1

Response
200

A list of Activities

Expand all
Copy code
    • true
    • [ ... ]
      • { ... }
        • { ... }

        Get details of an Activity

        Copy link
        Copy to clipboard
        GET

        /v1/activities/{id}

        Returns details of a specific Activity

        Path parameters

        id

        integer

        required

        The ID of the Activity

        Response
        200

        The request was successful

        Expand all
        Copy code
          • true
          • { ... }
            • { ... }

            Add an Activity

            Copy link
            Copy to clipboard
            POST

            /v1/activities

            Adds a new Activity. Includes more_activities_scheduled_in_context property in response's additional_data which indicates whether there are more undone Activities scheduled with the same Deal, Person or Organization (depending on the supplied data). For more information on how to add an Activity, see this tutorial.

            Body parameters

            application/json

            due_date

            string

            Due date of the Activity. Format: YYYY-MM-DD

            Format

            date

            due_time

            string

            Due time of the Activity in UTC. Format: HH:MM

            duration

            string

            Duration of the Activity. Format: HH:MM

            deal_id

            integer

            The ID of the Deal this Activity is associated with

            person_id

            integer

            The ID of the Person this Activity is associated with

            org_id

            integer

            The ID of the Organization this Activity is associated with

            note

            string

            Note of the Activity (HTML format)

            location

            string

            The address of the Activity. Pipedrive will automatically check if the location matches a geo-location on Google maps.

            public_description

            string

            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.

            subject

            string

            Subject of the Activity. When value for subject is not set, it will be given a default value Call.

            type

            string

            Type of the Activity. This is in correlation with the key_string parameter of ActivityTypes. When value for type is not set, it will be given a default value Call.

            user_id

            integer

            The ID of the User whom the Activity is assigned to. If omitted, the Activity is assigned to the authorized User.

            participants

            array

            List of multiple Persons (participants) this Activity is associated with. If omitted, single participant from person_id field is used. It requires a structure as follows: [{"person_id":1,"primary_flag":true}]

            busy_flag

            boolean

            Set the Activity 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 by never setting it or overriding it with null. 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.

            Values

            true

            false

            attendees

            array

            Attendees of the Activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows: [{"email_address":"[email protected]"}] or [{"person_id":1, "email_address":"[email protected]"}]

            done

            Whether the Activity is done or not. 0 = Not done, 1 = Done

            Values

            0

            1

            Response
            200

            The Activity was successfully added

            Expand all
            Copy code
              • true
              • { ... }
                • { ... }
                  • { ... }

                  Edit an Activity

                  Copy link
                  Copy to clipboard
                  PUT

                  /v1/activities/{id}

                  Modifies an Activity. Includes more_activities_scheduled_in_context property in response's additional_data which indicates whether there are more undone activities scheduled with the same Deal, Person or Organization (depending on the supplied data).

                  Path parameters

                  id

                  integer

                  required

                  The ID of the Activity

                  Body parameters

                  application/json

                  due_date

                  string

                  Due date of the Activity. Format: YYYY-MM-DD

                  Format

                  date

                  due_time

                  string

                  Due time of the Activity in UTC. Format: HH:MM

                  duration

                  string

                  Duration of the Activity. Format: HH:MM

                  deal_id

                  integer

                  The ID of the Deal this Activity is associated with

                  person_id

                  integer

                  The ID of the Person this Activity is associated with

                  org_id

                  integer

                  The ID of the Organization this Activity is associated with

                  note

                  string

                  Note of the Activity (HTML format)

                  location

                  string

                  The address of the Activity. Pipedrive will automatically check if the location matches a geo-location on Google maps.

                  public_description

                  string

                  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.

                  subject

                  string

                  Subject of the Activity

                  type

                  string

                  Type of the Activity. This is in correlation with the key_string parameter of ActivityTypes.

                  user_id

                  integer

                  The ID of the User whom the Activity is assigned to

                  participants

                  array

                  List of multiple Persons (participants) this Activity is associated with. It requires a structure as follows: [{"person_id":1,"primary_flag":true}]

                  busy_flag

                  boolean

                  Set the Activity 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 by never setting it or overriding it with null. 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.

                  Values

                  true

                  false

                  attendees

                  array

                  Attendees of the Activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows: [{"email_address":"[email protected]"}] or [{"person_id":1, "email_address":"[email protected]"}]

                  done

                  Whether the Activity is done or not. 0 = Not done, 1 = Done

                  Values

                  0

                  1

                  Response
                  200

                  The request was successful

                  Expand all
                  Copy code
                    • true
                    • { ... }
                      • { ... }

                      Delete multiple Activities in bulk

                      Copy link
                      Copy to clipboard
                      DELETE

                      /v1/activities

                      Marks multiple Activities as deleted

                      Query parameters

                      ids

                      string

                      required

                      Comma-separated IDs of Activities that will be deleted

                      Response
                      200

                      The Activities were successfully deleted

                      Expand all
                      Copy code
                        • true
                        • { ... }

                        Delete an Activity

                        Copy link
                        Copy to clipboard
                        DELETE

                        /v1/activities/{id}

                        Deletes an Activity

                        Path parameters

                        id

                        integer

                        required

                        The ID of the Activity

                        Response
                        200

                        The Activity was successfully deleted

                        Expand all
                        Copy code
                          • true
                          • { ... }

                          Subscribe to Pipedrive’s Developer Newsletter