> ## 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 Archived Projects

> List archived Pipedrive projects, filtered by status or phase. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List archived Pipedrive projects, filtered by status or phase.

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

## 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_archived_projects',
  {
    "filter_id": 123,
    "status": "example",
    "phase_id": 123
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute pipedrive_get_archived_projects --input '{
  "filter_id": 123,
  "status": "example",
  "phase_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,
        "title": "VP of Engineering",
        "description": "Example description"
      }
    ],
    "additional_data": {
      "next_cursor": "cursor_123"
    }
  }
}
```

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

## Input reference

Returns all archived projects.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.filter_id` | `integer` | No | — | If supplied, only projects matching the specified filter are returned |
| `payload.status` | `string` | No | — | If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned. |
| `payload.phase_id` | `integer` | No | — | If supplied, only projects in the specified phase are returned |
| `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 all archived projects.",
    "properties": {
      "filter_id": {
        "type": "integer",
        "description": "If supplied, only projects matching the specified filter are returned"
      },
      "status": {
        "type": "string",
        "description": "If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned."
      },
      "phase_id": {
        "type": "integer",
        "description": "If supplied, only projects in the specified phase are returned"
      },
      "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 | — | Projects array |
| `result.data.data[].id` | `integer` | No | — | The ID of the project |
| `result.data.data[].title` | `string` | No | — | The title of the project |
| `result.data.data[].description` | `string` | No | — | The description of the project |
| `result.data.data[].status` | `string` | No | — | The status of the project |
| `result.data.data[].board_id` | `integer` | No | — | The ID of the board this project is associated with |
| `result.data.data[].phase_id` | `integer` | No | — | The ID of the phase this project is associated with |
| `result.data.data[].owner_id` | `integer` | No | — | The ID of the user who owns the project |
| `result.data.data[].start_date` | `string` | No | — | The start date of the project. Format: YYYY-MM-DD Format: `date`. |
| `result.data.data[].end_date` | `string` | No | — | The end date of the project. Format: YYYY-MM-DD Format: `date`. |
| `result.data.data[].deal_ids` | `array` | No | — | An array of IDs of the deals this project is associated with |
| `result.data.data[].person_ids` | `array` | No | — | An array of IDs of the persons this project is associated with |
| `result.data.data[].org_ids` | `array` | No | — | An array of IDs of the organizations this project is associated with |
| `result.data.data[].label_ids` | `array` | No | — | An array of IDs of the labels this project has |
| `result.data.data[].health_status` | `integer \| null` | No | — | The health status of the project |
| `result.data.data[].add_time` | `string` | No | — | The creation date and time of the project in ISO 8601 format |
| `result.data.data[].update_time` | `string` | No | — | The last updated date and time of the project in ISO 8601 format |
| `result.data.data[].status_change_time` | `string` | No | — | The date and time of the last status change of the project in ISO 8601 format |
| `result.data.data[].archive_time` | `string \| null` | No | — | The date and time the project was archived in ISO 8601 format. If not archived, this field is null. |
| `result.data.data[].custom_fields` | `record` | No | — | An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error. |
| `result.data.additional_data` | `object` | No | — | The additional data of the list |
| `result.data.additional_data.next_cursor` | `string` | No | — | 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. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<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": "Projects array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "The ID of the project"
                },
                "title": {
                  "type": "string",
                  "description": "The title of the project"
                },
                "description": {
                  "type": "string",
                  "description": "The description of the project"
                },
                "status": {
                  "type": "string",
                  "description": "The status of the project"
                },
                "board_id": {
                  "type": "integer",
                  "description": "The ID of the board this project is associated with"
                },
                "phase_id": {
                  "type": "integer",
                  "description": "The ID of the phase this project is associated with"
                },
                "owner_id": {
                  "type": "integer",
                  "description": "The ID of the user who owns the project"
                },
                "start_date": {
                  "type": "string",
                  "description": "The start date of the project. Format: YYYY-MM-DD",
                  "format": "date"
                },
                "end_date": {
                  "type": "string",
                  "description": "The end date of the project. Format: YYYY-MM-DD",
                  "format": "date"
                },
                "deal_ids": {
                  "type": "array",
                  "description": "An array of IDs of the deals this project is associated with",
                  "items": {
                    "type": "integer"
                  }
                },
                "person_ids": {
                  "type": "array",
                  "description": "An array of IDs of the persons this project is associated with",
                  "items": {
                    "type": "integer"
                  }
                },
                "org_ids": {
                  "type": "array",
                  "description": "An array of IDs of the organizations this project is associated with",
                  "items": {
                    "type": "integer"
                  }
                },
                "label_ids": {
                  "type": "array",
                  "description": "An array of IDs of the labels this project has",
                  "items": {
                    "type": "integer"
                  }
                },
                "health_status": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "description": "The health status of the project"
                },
                "add_time": {
                  "type": "string",
                  "description": "The creation date and time of the project in ISO 8601 format"
                },
                "update_time": {
                  "type": "string",
                  "description": "The last updated date and time of the project in ISO 8601 format"
                },
                "status_change_time": {
                  "type": "string",
                  "description": "The date and time of the last status change of the project in ISO 8601 format"
                },
                "archive_time": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The date and time the project was archived in ISO 8601 format. If not archived, this field is null."
                },
                "custom_fields": {
                  "type": "object",
                  "description": "An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.",
                  "additionalProperties": true
                }
              },
              "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.