> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Pipedrive: Get Activities

> List Pipedrive activities, filtered by owner, deal, lead, person, organization, done state or update date. Includes SDK V2 examples, schemas, and cost.

List Pipedrive activities, filtered by owner, deal, lead, person, organization, done state or update date.

> [!NOTE]
>
> Tool ID: `pipedrive_get_activities`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pipedrive_get_activities',
  {
    "filter_id": 123,
    "ids": "example",
    "owner_id": 123
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute pipedrive_get_activities --input '{
  "filter_id": 123,
  "ids": "example",
  "owner_id": 123
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "success": true,
    "data": [
      {
        "id": 123,
        "subject": "Introduction",
        "type": "example"
      }
    ],
    "additional_data": {
      "next_cursor": "cursor_123"
    }
  }
}
```

Use `deepline describe pipedrive_get_activities --json` for the latest machine-readable contract.

## Input reference

Returns data about all activities.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.filter_id` | `integer` | No | — | If supplied, only activities matching the specified filter are returned |
| `payload.ids` | `string` | No | — | Optional comma separated string array of up to 100 entity ids to fetch. If filter\_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. |
| `payload.owner_id` | `integer` | No | — | If supplied, only activities owned by the specified user are returned. If filter\_id is provided, this is ignored. |
| `payload.deal_id` | `integer` | No | — | If supplied, only activities linked to the specified deal are returned. If filter\_id is provided, this is ignored. |
| `payload.lead_id` | `string` | No | — | If supplied, only activities linked to the specified lead are returned. If filter\_id is provided, this is ignored. |
| `payload.person_id` | `integer` | No | — | If supplied, only activities whose primary participant is the given person are returned. If filter\_id is provided, this is ignored. |
| `payload.org_id` | `integer` | No | — | If supplied, only activities linked to the specified organization are returned. If filter\_id is provided, this is ignored. |
| `payload.done` | `boolean` | No | — | If supplied, only activities with specified 'done' flag value are returned |
| `payload.updated_since` | `string` | No | — | If set, only activities with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. |
| `payload.updated_until` | `string` | No | — | If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. |
| `payload.sort_by` | `"id" \| "update_time" \| "add_time" \| "due_date"` | No | `"id"` | The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`. Allowed: `id`, `update_time`, `add_time`, `due_date`. |
| `payload.sort_direction` | `"asc" \| "desc"` | No | `"asc"` | The sorting direction. Supported values: `asc`, `desc`. Allowed: `asc`, `desc`. |
| `payload.include_fields` | `"attendees"` | No | — | Optional comma separated string array of additional fields to include Allowed: `attendees`. |
| `payload.limit` | `integer` | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
| `payload.cursor` | `string` | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns data about all activities.",
    "properties": {
      "filter_id": {
        "type": "integer",
        "description": "If supplied, only activities matching the specified filter are returned"
      },
      "ids": {
        "type": "string",
        "description": "Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response."
      },
      "owner_id": {
        "type": "integer",
        "description": "If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored."
      },
      "deal_id": {
        "type": "integer",
        "description": "If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored."
      },
      "lead_id": {
        "type": "string",
        "description": "If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored."
      },
      "person_id": {
        "type": "integer",
        "description": "If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored."
      },
      "org_id": {
        "type": "integer",
        "description": "If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored."
      },
      "done": {
        "type": "boolean",
        "description": "If supplied, only activities with specified 'done' flag value are returned"
      },
      "updated_since": {
        "type": "string",
        "description": "If set, only activities with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z."
      },
      "updated_until": {
        "type": "string",
        "description": "If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z."
      },
      "sort_by": {
        "type": "string",
        "description": "The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.",
        "default": "id",
        "enum": [
          "id",
          "update_time",
          "add_time",
          "due_date"
        ]
      },
      "sort_direction": {
        "type": "string",
        "description": "The sorting direction. Supported values: `asc`, `desc`.",
        "default": "asc",
        "enum": [
          "asc",
          "desc"
        ]
      },
      "include_fields": {
        "type": "string",
        "description": "Optional comma separated string array of additional fields to include",
        "enum": [
          "attendees"
        ]
      },
      "limit": {
        "type": "integer",
        "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
      },
      "cursor": {
        "type": "string",
        "description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.success` | `boolean` | No | — | If the response is successful or not |
| `result.data.data` | `array` | No | — | Activities array |
| `result.data.data[].id` | `integer` | No | — | The ID of the activity |
| `result.data.data[].subject` | `string` | No | — | The subject of the activity |
| `result.data.data[].type` | `string` | No | — | The type of the activity |
| `result.data.data[].owner_id` | `integer` | No | — | The ID of the user who owns the activity |
| `result.data.data[].creator_user_id` | `integer` | No | — | The ID of the user who created the activity |
| `result.data.data[].is_deleted` | `boolean` | No | — | Whether the activity is deleted or not |
| `result.data.data[].add_time` | `string` | No | — | The creation date and time of the activity |
| `result.data.data[].update_time` | `string` | No | — | The last updated date and time of the activity |
| `result.data.data[].deal_id` | `integer` | No | — | The ID of the deal linked to the activity |
| `result.data.data[].lead_id` | `string` | No | — | The ID of the lead linked to the activity |
| `result.data.data[].person_id` | `integer` | No | — | The ID of the person linked to the activity |
| `result.data.data[].org_id` | `integer` | No | — | The ID of the organization linked to the activity |
| `result.data.data[].project_id` | `integer` | No | — | The ID of the project linked to the activity |
| `result.data.data[].due_date` | `string` | No | — | The due date of the activity |
| `result.data.data[].due_time` | `string` | No | — | The due time of the activity |
| `result.data.data[].duration` | `string` | No | — | The duration of the activity |
| `result.data.data[].busy` | `boolean` | No | — | Whether the activity marks the assignee as busy or not in their calendar |
| `result.data.data[].done` | `boolean` | No | — | Whether the activity is marked as done or not |
| `result.data.data[].marked_as_done_time` | `string` | No | — | The date and time when the activity was marked as done |
| `result.data.data[].location` | `object` | No | — | Location of the activity |
| `result.data.data[].location.value` | `string` | No | — | The full address of the activity |
| `result.data.data[].location.country` | `string` | No | — | Country of the activity |
| `result.data.data[].location.admin_area_level_1` | `string` | No | — | Admin area level 1 (e.g. state) of the activity |
| `result.data.data[].location.admin_area_level_2` | `string` | No | — | Admin area level 2 (e.g. county) of the activity |
| `result.data.data[].location.locality` | `string` | No | — | Locality (e.g. city) of the activity |
| `result.data.data[].location.sublocality` | `string` | No | — | Sublocality (e.g. neighborhood) of the activity |
| `result.data.data[].location.route` | `string` | No | — | Route (e.g. street) of the activity |
| `result.data.data[].location.street_number` | `string` | No | — | Street number of the activity |
| `result.data.data[].location.subpremise` | `string` | No | — | Subpremise (e.g. apartment/suite number) of the activity |
| `result.data.data[].location.postal_code` | `string` | No | — | Postal code of the activity |
| `result.data.data[].participants` | `array` | No | — | The participants of the activity |
| `result.data.data[].participants[].person_id` | `integer` | No | — | The ID of the person |
| `result.data.data[].participants[].primary` | `boolean` | No | — | Whether the person is the primary participant or not |
| `result.data.data[].attendees` | `array` | No | — | The attendees of the activity |
| `result.data.data[].attendees[].email` | `string` | No | — | The email address of the attendee |
| `result.data.data[].attendees[].name` | `string` | No | — | The name of the attendee |
| `result.data.data[].attendees[].status` | `string` | No | — | The status of the attendee |
| `result.data.data[].attendees[].is_organizer` | `boolean` | No | — | Whether the attendee is the organizer or not |
| `result.data.data[].attendees[].person_id` | `integer` | No | — | The ID of the person if the attendee has a person record |
| `result.data.data[].attendees[].user_id` | `integer` | No | — | The ID of the user if the attendee is a user |
| `result.data.data[].conference_meeting_client` | `string` | No | — | The client used for the conference meeting |
| `result.data.data[].conference_meeting_url` | `string` | No | — | The URL of the conference meeting |
| `result.data.data[].conference_meeting_id` | `string` | No | — | The ID of the conference meeting |
| `result.data.data[].public_description` | `string` | No | — | The public description of the activity |
| `result.data.data[].priority` | `integer` | No | — | The priority of the activity. Mappable to a specific string using activityFields API. |
| `result.data.data[].note` | `string` | No | — | The note of the activity |
| `result.data.additional_data` | `object` | No | — | The additional data of the list |

The table shows the first 50 fields. Expand the raw schema below for every field.

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "If the response is successful or not"
          },
          "data": {
            "type": "array",
            "description": "Activities array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "The ID of the activity"
                },
                "subject": {
                  "type": "string",
                  "description": "The subject of the activity"
                },
                "type": {
                  "type": "string",
                  "description": "The type of the activity"
                },
                "owner_id": {
                  "type": "integer",
                  "description": "The ID of the user who owns the activity"
                },
                "creator_user_id": {
                  "type": "integer",
                  "description": "The ID of the user who created the activity"
                },
                "is_deleted": {
                  "type": "boolean",
                  "description": "Whether the activity is deleted or not"
                },
                "add_time": {
                  "type": "string",
                  "description": "The creation date and time of the activity"
                },
                "update_time": {
                  "type": "string",
                  "description": "The last updated date and time of the activity"
                },
                "deal_id": {
                  "type": "integer",
                  "description": "The ID of the deal linked to the activity"
                },
                "lead_id": {
                  "type": "string",
                  "description": "The ID of the lead linked to the activity"
                },
                "person_id": {
                  "type": "integer",
                  "description": "The ID of the person linked to the activity"
                },
                "org_id": {
                  "type": "integer",
                  "description": "The ID of the organization linked to the activity"
                },
                "project_id": {
                  "type": "integer",
                  "description": "The ID of the project linked to the activity"
                },
                "due_date": {
                  "type": "string",
                  "description": "The due date of the activity"
                },
                "due_time": {
                  "type": "string",
                  "description": "The due time of the activity"
                },
                "duration": {
                  "type": "string",
                  "description": "The duration of the activity"
                },
                "busy": {
                  "type": "boolean",
                  "description": "Whether the activity marks the assignee as busy or not in their calendar"
                },
                "done": {
                  "type": "boolean",
                  "description": "Whether the activity is marked as done or not"
                },
                "marked_as_done_time": {
                  "type": "string",
                  "description": "The date and time when the activity was marked as done"
                },
                "location": {
                  "type": "object",
                  "description": "Location of the activity",
                  "properties": {
                    "value": {
                      "type": "string",
                      "description": "The full address of the activity"
                    },
                    "country": {
                      "type": "string",
                      "description": "Country of the activity"
                    },
                    "admin_area_level_1": {
                      "type": "string",
                      "description": "Admin area level 1 (e.g. state) of the activity"
                    },
                    "admin_area_level_2": {
                      "type": "string",
                      "description": "Admin area level 2 (e.g. county) of the activity"
                    },
                    "locality": {
                      "type": "string",
                      "description": "Locality (e.g. city) of the activity"
                    },
                    "sublocality": {
                      "type": "string",
                      "description": "Sublocality (e.g. neighborhood) of the activity"
                    },
                    "route": {
                      "type": "string",
                      "description": "Route (e.g. street) of the activity"
                    },
                    "street_number": {
                      "type": "string",
                      "description": "Street number of the activity"
                    },
                    "subpremise": {
                      "type": "string",
                      "description": "Subpremise (e.g. apartment/suite number) of the activity"
                    },
                    "postal_code": {
                      "type": "string",
                      "description": "Postal code of the activity"
                    }
                  },
                  "additionalProperties": false
                },
                "participants": {
                  "type": "array",
                  "description": "The participants of the activity",
                  "items": {
                    "type": "object",
                    "properties": {
                      "person_id": {
                        "type": "integer",
                        "description": "The ID of the person"
                      },
                      "primary": {
                        "type": "boolean",
                        "description": "Whether the person is the primary participant or not"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "attendees": {
                  "type": "array",
                  "description": "The attendees of the activity",
                  "items": {
                    "type": "object",
                    "properties": {
                      "email": {
                        "type": "string",
                        "description": "The email address of the attendee"
                      },
                      "name": {
                        "type": "string",
                        "description": "The name of the attendee"
                      },
                      "status": {
                        "type": "string",
                        "description": "The status of the attendee"
                      },
                      "is_organizer": {
                        "type": "boolean",
                        "description": "Whether the attendee is the organizer or not"
                      },
                      "person_id": {
                        "type": "integer",
                        "description": "The ID of the person if the attendee has a person record"
                      },
                      "user_id": {
                        "type": "integer",
                        "description": "The ID of the user if the attendee is a user"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "conference_meeting_client": {
                  "type": "string",
                  "description": "The client used for the conference meeting"
                },
                "conference_meeting_url": {
                  "type": "string",
                  "description": "The URL of the conference meeting"
                },
                "conference_meeting_id": {
                  "type": "string",
                  "description": "The ID of the conference meeting"
                },
                "public_description": {
                  "type": "string",
                  "description": "The public description of the activity"
                },
                "priority": {
                  "type": "integer",
                  "description": "The priority of the activity. Mappable to a specific string using activityFields API."
                },
                "note": {
                  "type": "string",
                  "description": "The note of the activity"
                }
              },
              "additionalProperties": false
            }
          },
          "additional_data": {
            "type": "object",
            "description": "The additional data of the list",
            "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."
              }
            },
            "additionalProperties": false
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Pipedrive provider guide](https://deepline.com/docs/providers/pipedrive/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.