RErecruitwithatlas
Campaigns

Get a campaign by ID

Changed on

Returns a single outreach campaign template by ID — its full step sequence, scheduling settings, attached files, and, per step, the standard variables and the distinct {{ai:...}} prompts as aiVariables. Resolve each AI prompt using GET /api/v1/people/{personId} (experiences, headlineRole) and GET /api/v1/projects/{entityId} or GET /api/v1/opportunities/{entityId} (jobDescription), then supply the values at POST /api/v1/campaigns/{id}/launch.

get/api/v1/campaigns/{id}

Request

Path parameters

idstring uuid required

ID of the campaign to retrieve

Example:550e8400-e29b-41d4-a716-446655440000

Response

Campaign details with steps, files, and variables summary

status'ok' required

Example response

{
  "data": {
    "name": "Q1 Senior Engineers Outreach",
    "status": "active",
    "type": "candidate_outreach",
    "createdAt": "2026-04-15T10:30:00.000Z",
    "updatedAt": "2026-05-01T14:22:00.000Z",
    "steps": [
      {
        "position": 1,
        "type": "email",
        "dispatchType": "new_thread",
        "subject": "Exciting opportunity at {{client_name}}",
        "variables": [
          {
            "type": "person_first_name",
            "name": "firstName"
          }
        ],
        "aiVariables": [
          {
            "name": "List the full and entire job description including formatting"
          }
        ],
        "scheduledOn": "2026-05-10",
        "intervalTime": "09:00",
        "intervalDays": 3,
        "timezone": "Europe/London",
        "files": [
          {
            "id": "ff000000-0000-0000-0000-000000000001",
            "name": "resume.pdf"
          }
        ]
      }
    ]
  }
}

Changes