Get file headers (by campaign id)

Overview

Get the file-header configuration(s) for a given automation campaign. Note: the {campaignId} path segment is the campaign id (not the file-header id). The campaign must exist, be of type automation, and belong to the caller's company.

Prerequisites

• A bearer token in the Authorization header.
• The campaignId of the record you are targeting.

Base URL

Endpoint

GET /api/v1/campaign/automate/file-headers/{campaignId}

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Account bearer. Campaign is matched on the caller's person.company_id, else 404.

Rate limit

• No rate limit.

Path parameters

How it works

• 200 with an array of file-header rows under data.data (selected columns only: id, rs_campaign_id, headers, sample_file_path, location_identifier, timestamps).
• 404 if the campaign is not found / not an automation campaign / not owned by the caller.

Response

200 OK · 200

{
  "data": {
    "status": "success",
    "data": [
      {
        "id": 4,
        "rs_campaign_id": 12,
        "headers": {
          "email": "Email Address",
          "phone": "Phone Number",
          "customer_name": "Customer Name",
          "location_identifier": "Store ID"
        },
        "sample_file_path": "campaign_automation/sample_files/1718447400_sample.xlsx",
        "location_identifier": "Store ID",
        "created_at": "2026-06-15T10:30:00.000000Z",
        "updated_at": "2026-06-15T10:30:00.000000Z"
      }
    ]
  }
}

404 Campaign not found · 404

{
  "message": "Campaign not found or not authorized",
  "status": "error",
  "errors": []
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/campaign/automate/file-headers/123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'