--- title: "Get campaign" method: GET path: "/api/v2/campaigns/{id}" tags: ["Campaign"] --- # Get campaign `GET /api/v2/campaigns/{id}` Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all` ## Path parameters - `id` string, uuid, required ## Response `200` The requested Campaign - Campaign — A campaign that can be sent to a list of recipients - `id` string, uuid, required — Unique identifier for the campaign - `name` string, required — Name of the campaign - `pl_value` number, nullable — Value of every positive lead - `status` -99 | -1 | -2 | 0 | 1 | 2 | 3 | 4, required — Campaign Status - `is_evergreen` boolean, nullable — Whether the campaign is evergreen - `campaign_schedule` object, required — Campaign schedule - `start_date` string, date, nullable — Start date in YYYY-MM-DD format. Uses the campaign's timezone. - `end_date` string, date, nullable — End date in YYYY-MM-DD format. Uses the campaign's timezone. - `schedules` object[], required - `name` string, required - `timing` object, required - `from` string, required - `to` string, required - `days` object, required - `0` boolean - `1` boolean - `2` boolean - `3` boolean - `4` boolean - `5` boolean - `6` boolean - `timezone` 'Etc/GMT+12' | 'Etc/GMT+11' | 'Etc/GMT+10' | 'America/Anchorage' | 'America/Dawson' | 'America/Creston' | 'America/Chihuahua' | 'America/Boise' | 'America/Belize' | 'America/Chicago' | 'America/Bahia_Banderas' | 'America/Regina' | 'America/Bogota' | 'America/Detroit' | 'America/Indiana/Marengo' | 'America/Caracas' | 'America/Asuncion' | 'America/Glace_Bay' | 'America/Campo_Grande' | 'America/Anguilla' | 'America/Santiago' | 'America/St_Johns' | 'America/Sao_Paulo' | 'America/Argentina/La_Rioja' | 'America/Araguaina' | 'America/Godthab' | 'America/Montevideo' | 'America/Bahia' | 'America/Noronha' | 'America/Scoresbysund' | 'Atlantic/Cape_Verde' | 'Africa/Casablanca' | 'America/Danmarkshavn' | 'Europe/Isle_of_Man' | 'Atlantic/Canary' | 'Africa/Abidjan' | 'Arctic/Longyearbyen' | 'Europe/Belgrade' | 'Africa/Ceuta' | 'Europe/Sarajevo' | 'Africa/Algiers' | 'Africa/Windhoek' | 'Asia/Nicosia' | 'Asia/Beirut' | 'Africa/Cairo' | 'Asia/Damascus' | 'Europe/Bucharest' | 'Africa/Blantyre' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Asia/Jerusalem' | 'Africa/Tripoli' | 'Asia/Amman' | 'Asia/Baghdad' | 'Europe/Kaliningrad' | 'Asia/Aden' | 'Africa/Addis_Ababa' | 'Europe/Kirov' | 'Europe/Astrakhan' | 'Asia/Tehran' | 'Asia/Dubai' | 'Asia/Baku' | 'Indian/Mahe' | 'Asia/Tbilisi' | 'Asia/Yerevan' | 'Asia/Kabul' | 'Antarctica/Mawson' | 'Asia/Yekaterinburg' | 'Asia/Karachi' | 'Asia/Kolkata' | 'Asia/Colombo' | 'Asia/Kathmandu' | 'Antarctica/Vostok' | 'Asia/Dhaka' | 'Asia/Rangoon' | 'Antarctica/Davis' | 'Asia/Novokuznetsk' | 'Asia/Hong_Kong' | 'Asia/Krasnoyarsk' | 'Asia/Brunei' | 'Australia/Perth' | 'Asia/Taipei' | 'Asia/Choibalsan' | 'Asia/Irkutsk' | 'Asia/Dili' | 'Asia/Pyongyang' | 'Australia/Adelaide' | 'Australia/Darwin' | 'Australia/Brisbane' | 'Australia/Melbourne' | 'Antarctica/DumontDUrville' | 'Australia/Currie' | 'Asia/Chita' | 'Antarctica/Macquarie' | 'Asia/Sakhalin' | 'Pacific/Auckland' | 'Etc/GMT-12' | 'Pacific/Fiji' | 'Asia/Anadyr' | 'Asia/Kamchatka' | 'Etc/GMT-13' | 'Pacific/Apia', required - `sequences` object[] — List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array - `steps` object[], required - `type` 'email', required — Type of step. This has to be 'email' always - it's the only supported type for now - `delay` number, required — The delay value before sending the NEXT email. The unit is determined by the delay_unit field (defaults to days). - `delay_unit` 'minutes' | 'hours' | 'days' — The unit of time for the delay value (minutes, hours, or days). Defaults to days for backward compatibility. - `pre_delay` number — The delay value before sending the FIRST email in a subsequence. **Only applicable to subsequences** - this field is ignored for regular campaigns. The unit is determined by the pre_delay_unit field (defaults to days). - `pre_delay_unit` 'minutes' | 'hours' | 'days' — The unit of time for the pre_delay value (minutes, hours, or days). **Only applicable to subsequences** - this field is ignored for regular campaigns. Defaults to days for backward compatibility. - `variants` object[], required - `subject` string, required - `body` string, required - `v_disabled` boolean — Whether this variant is disabled. By default, all the variants are enabled. Please set this to true if you want to disable this variant - `timestamp_created` string, required — Timestamp when the campaign was created - `timestamp_updated` string, required — Timestamp when the campaign was last updated - `email_gap` number, nullable — The gap between emails in minutes - `random_wait_max` number, nullable — The maximum random wait time in minutes - `text_only` boolean, nullable — Whether the campaign is text only - `first_email_text_only` boolean, nullable — Whether the campaign is send the first email as a text only - `email_list` string[] — List of accounts to use for sending emails - `daily_limit` number, nullable — The daily limit for sending emails - `stop_on_reply` boolean, nullable — Whether to stop the campaign on reply - `email_tag_list` string[] — List of tags to use for sending emails - `link_tracking` boolean, nullable — Whether to track links in emails - `open_tracking` boolean — Whether to track opens in emails - `stop_on_auto_reply` boolean, nullable — Whether to stop the campaign on auto reply - `daily_max_leads` integer, nullable — The daily maximum new leads to contact - `prioritize_new_leads` boolean, nullable — Whether to prioritize new leads - `auto_variant_select` object, nullable — Auto variant select settings - `trigger` 'reply_rate' | 'click_rate' | 'open_rate', required - `match_lead_esp` boolean, nullable — Whether to match leads by ESP - `not_sending_status` 1 | 2 | 3 | 4 | 99, nullable — Campaign not sending status - `stop_for_company` boolean, nullable — Whether to stop the campaign for the entire company(domain) when a lead replies - `core_variables` object, nullable — Campaign core variables - `custom_variables` object, nullable — Campaign custom variables - `insert_unsubscribe_header` boolean, nullable — Whether to insert an unsubscribe header in emails - `allow_risky_contacts` boolean, nullable — Whether to allow risky contacts - `disable_bounce_protect` boolean, nullable — Whether to disable bounce protection - `limit_emails_per_company_override` object, nullable — Overrides the workspace-wide limit emails per company setting for this campaign. - `mode` 'custom' | 'disabled', required - `daily_limit` number - `scope` 'per_campaign' | 'across_workspace' - `cc_list` string[] — List of accounts to CC on emails - `bcc_list` string[] — List of accounts to BCC on emails - `organization` string, uuid, nullable — Organization ID - `owned_by` string, uuid, nullable — Owner ID - `ai_sdr_id` string, uuid, nullable — AI Sales Agent ID that created this campaign - `provider_routing_rules` object[] — Auto variant select settings - `action` 'send' | 'do_not_send' - `recipient_esp` string[] - `sender_esp` string[] ## Other responses - `401` — This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked) - `402` — This request cannot be fulfilled because the workspace does not have an active paid plan - `404` — The requested resource was not found - `429` — You have exceeded the rate limit. Please check the rate limit docs for more information. --- [API](https://skmtc.net/instantly/apis/api-explorer.md) · [All operations](https://skmtc.net/instantly/apis/api-explorer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/instantly/api-explorer/revisions/378d1e253fe7/schema)