Outreach

Get campaign definition

Read everything that decides who a campaign contacts and what it says — the app's Campaign tab in one call.

Who it targets: offer, customer_problem, target_role, target_geography, target_company_size, positive_criteria, negative_criteria, example_clients, and the derived keywords.

What it says: instructions (first email), followup_instructions (shared by every follow-up), language, and the project-level reply_instructions.

When it says it: schedule (the send days) and followups (how many emails the sequence has and how far apart — a project-level setting, the same for every campaign of the project).

targeting_editable is false for a campaign built from your own imported lead list — its audience is that list, so the targeting fields are locked.

Free, and the natural first call when auditing an account: one request per campaign tells you whether it is aimed at the right people, before a single email goes out.

get/public/api/v1/autogtm/campaigns/{campaign_id}

Request

  • Base URL: https://api.explee.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.explee.com/public/api/v1/autogtm/campaigns/{campaign_id}
  • Auth: APIKeyHeader (a scheme the document does not define)

Path parameters

campaign_idinteger required

Response

Successful Response

idinteger required

Campaign identifier.

project_idinteger required

Project this campaign belongs to.

namestring nullable

Human-readable campaign name.

statusstring required

Raw lifecycle status: discovery, review, outreach, listening, error, archived.

status_reasonstring nullable

Why a listening campaign stopped sending — user_pause, budget_pause, lead_pool_exhausted, …

daily_limit_usdinteger nullable

Campaign's daily budget cap in USD.

target_urlstring nullable

Booking link used in the emails. Read-only here — it is gated and shared across the project.

offerstring nullable

What you offer this audience ("What you offer" in the app).

customer_problemstring nullable

The problem this audience has ("Customer problem").

target_rolestring nullable

Who to reach at the prospect, by responsibility ("Target role").

target_geographystring nullable

Target geographies, free text ("Target geography").

target_company_sizestring nullable

Target company size, free text.

positive_criteriastring[]

Signals that qualify a company for this campaign.

negative_criteriastring[]

Disqualifying signals — look-alikes that are NOT a fit.

example_clientsstring[]

Recognizable companies that fit this ICP.

keywordsstring nullable

Comma-separated search keywords. Read-only: derived by Explee from the fields above.

instructionsstring

Your brief for the first email. Empty = briefed from the project alone.

followup_instructionsstring

The shared brief for every follow-up in the sequence.

languagestring required

Language code the emails are written in; auto picks per lead.

reply_instructionsstring

How replies are answered. Project-level — shared by every campaign in the project, and read-only here; it is edited in the app.

targeting_editableboolean required

False for a campaign created from your own imported lead list: its audience is the list you uploaded, so the two SEARCH fields — target_geography and target_company_size — are locked (a write returns 409). target_role, positive_criteria and negative_criteria also shape the email copy, so they stay writable (200) and simply re-aim nothing. The offer and the email briefs stay editable either way.

Example response

{
  "id": 17518,
  "status": "outreach",
  "language": "auto",
  "schedule": {
    "days": [
      "mon",
      "tue",
      "wed",
      "thu",
      "fri"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.