Retrieve Campaign

GET

api.ziett.co/c/v1 /campaigns/{campaign_id}

Fetch comprehensive configuration specifics, execution status timestamps, and metadata configuration records for a single batch campaign pipeline instance. This is the foundational diagnostic endpoint used to safely poll asynchronous ingestion status states or fetch auditing data summaries right after completing massive distributions.

To review a chronological history index containing all of your workspace's campaigns simultaneously, navigate to List Campaigns.

Request

Required scope: apikey:campaign:read

Path Parameters

Parameter	Type	Description
`campaign_id`	`uuid`	The unique tracker token reference assigned to the batch campaign pipeline resource.

Examples

import httpx

campaign_id = "019b4b56-e704-7c30-83a0-527df63c3e00"

response = httpx.get(
    f"https://api.ziett.co/c/v1/campaigns/{campaign_id}",
    headers={
        "X-API-KEY": "zk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    }
)

print(response.json())

curl -X GET "https://api.ziett.co/c/v1/campaigns/019b4b56-e704-7c30-83a0-527df63c3e00" \
  -H "X-API-KEY: zk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx"

const campaignId = "019b4b56-e704-7c30-83a0-527df63c3e00";

const response = await fetch(`https://api.ziett.co/c/v1/campaigns/${campaignId}`, {
  method: "GET",
  headers: {
    "X-API-KEY": "zk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  },
});

const data = await response.json();
console.log(data);

Responses

`200 OK` — Campaign Details Retrieved

The target batch resource ledger was successfully analyzed and returned.

{
  "id": "019b4b56-e704-7c30-83a0-527df63c3e00",
  "name": "Black Friday Promo - Luanda",
  "status": "COMPLETED",
  "organization_id": "019b4b56-ab10-7210-81a1-527df63c3111",
  "billing_account_id": "019b4b56-bc20-7315-92b2-627df63c3222",
  "trigger_source": "API",
  "file_metadata_id": null,
  "channel_type": "SMS",
  "sms_remitter_id": "019b4b56-de40-7530-b4d4-827df63c3444",
  "sms_remitter": {
    "id": "019b4b56-de40-7530-b4d4-827df63c3444",
    "name": "InfoZiett"
  },
  "content": "Flash Sale! Enjoy 50% off on all items this weekend only.",
  "total_estimated_recipients": 3,
  "scheduled_at": null,
  "processed_at": "2026-06-02T14:00:02.000000+00:00",
  "completed_at": "2026-06-02T14:02:15.000000+00:00",
  "error_code": null,
  "status_note": "All recipient segments parsed, compiled, and handed over to carrier routing lines successfully.",
  "data": {
    "reason_of_pause": "string"
  },
  "created_at": "2026-06-02T14:00:00.000000+00:00",
  "updated_at": "2026-06-02T14:02:15.000000+00:00"
}

Response Fields

Field	Type	Description
`id`	`uuid`	The campaign's unique UUID v7 system resource tracking index.
`name`	`string`	Friendly custom label identifying the batch distribution run.
`status`	`enum`	Active workflow progress tracking status code. Values: `DRAFT`, `SCHEDULED`, `PROCESSING`, `SENDING`, `COMPLETED`, `CANCELLED`, `FAILED`, `PAUSED`.
`organization_id`	`uuid`	The identity context token of the company space hosting this resource.
`billing_account_id`	`uuid`	The ledger asset balance configuration identifier responsible for covering financial deductions.
`trigger_source`	`enum`	Pipeline ingress context tracking vector pointing out how the job was submitted.
`file_metadata_id`	`uuid` \| `null`	Relational reference token indicating a dashboard uploaded list if the job originated from a manual CSV file ingest.
`channel_type`	`enum`	The communications medium system layer used for dispatch. Values: `SMS`
`sms_remitter_id`	`uuid` \| `null`	Sender alphanumeric or numerical routing token configuration applied.
`sms_remitter`	`object` \| `null`	Complex structured details containing alphanumeric sender masking tags or active configurations.
`content`	`string`	The explicit payload blueprint template text body dispatched across all target numbers.
`total_estimated_recipients`	`integer`	Count summary metrics documenting the volume of target recipient variables ingested initially.
`scheduled_at`	`datetime` \| `null`	ISO standard datetime timestamp defining a future execution calendar date if the delivery was paused for automated submission.
`processed_at`	`datetime` \| `null`	Timestamp documenting precisely when validation checks concluded and wallet balance calculations were finalized.
`completed_at`	`datetime` \| `null`	Timestamp documenting when background workers finished queueing the last payload item onto carrier infrastructure networks.
`error_code`	`enum` \| `null`	Global category failure code flagging operational issues that might have abruptly halted processing.
`status_note`	`string` \| `null`	Descriptive system logging information detailing current tasks, optimization alerts, or execution warnings.
`data`	`object`	An embedded tracking payload that breaks down real-time metrics, accounting details, and transaction processing tallies.
`created_at`	`datetime`	Precise creation metadata pinpointing when the original request structure was stored.
`updated_at`	`datetime` \|`null`	Tracking marker documenting when internal database properties last changed state.

`401 Unauthorized` — Invalid API Key

The authentication security checks failed due to invalid token access keys.

{
  "code": "AUTH_INVALID_API_KEY",
  "message": "The provided API key is invalid or has been revoked.",
  "status": 401,
  "trace_id": "d4e5f644358a9e7011c123c831a1b2c3",
  "timestamp": "2026-06-02T14:00:00.000000+00:00",
  "service": "core"
}

`404 Not Found` — Campaign Not Found

The requested identifier reference pattern does not exist or belongs to a different organization block entirely.

{
  "code": "NOT_FOUND",
  "message": "The requested campaign resource tracking profile could not be found.",
  "status": 404,
  "trace_id": "e5f644358a9e7011c123c831a1b2c3d4",
  "timestamp": "2026-06-02T14:00:00.000000+00:00",
  "service": "core"
}

`422 Unprocessable Entity` — Validation Error

The validation layer dropped the execution flow because the path routing template variable syntax structure is malformed.

{
  "code": "VALIDATION_ERROR",
  "message": "One or more fields failed validation.",
  "status": 422,
  "trace_id": "f812a3bc91e044358a9e7011c456d901",
  "timestamp": "2026-06-02T14:00:00.000000+00:00",
  "service": "core",
  "fields": {
    "campaign_id": "Value must conform to a valid UUID v7 format rule pattern structure."
  }
}

Send Batch Campaign — Submit an optimized payload containing up to 1,000 recipient lines.

Send Batch Campaign

Initiate a large-scale messaging campaign for up to 1,000 recipients in a single request.