> ## 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.

# Instantly: Get Campaign

> Get one Instantly campaign's details and status by campaign ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get one Instantly campaign's details and status by campaign ID.

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

## 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(
  'instantly_get_campaign',
  {
    "campaign_id": "campaign_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute instantly_get_campaign --input '{
  "campaign_id": "campaign_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"]}}
{
  "id": "id_123",
  "name": "Example",
  "status": 123
}
```

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

## Input reference

Get details of a specific Instantly campaign.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.campaign_id` | `string` | Yes | — | Minimum length: 1. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get details of a specific Instantly campaign.",
    "properties": {
      "campaign_id": {
        "type": "string",
        "minLength": 1,
        "aliases": [
          "id"
        ]
      }
    },
    "required": [
      "campaign_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Instantly campaign detail.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.id` | `string` | Yes | — | — |
| `result.name` | `string` | Yes | — | — |
| `result.status` | `integer` | Yes | — | — |
| `result.sequences` | `array` | No | — | — |
| `result.campaign_schedule` | `unknown` | No | — | — |
| `result.email_list` | `array` | No | — | — |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Instantly campaign detail.",
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "status": {
        "type": "integer"
      },
      "sequences": {
        "type": "array",
        "items": {}
      },
      "campaign_schedule": {},
      "email_list": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "required": [
      "id",
      "name",
      "status"
    ],
    "additionalProperties": true
  }
  ```
</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

* [Instantly provider guide](https://deepline.com/docs/providers/instantly/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.