Ziett
Docs
Docs
  • API Reference
Docs
Docs
  • API Reference
Meet Ziett
Login
  1. Campaigns
  • API Docs - Ziett
  • API Reference
    • Overview
    • Messages
      • Send Transactional Message
      • List Organization Messages
      • Retrieve Message Details
    • Campaigns
      • List Organization Campaigns
        GET
      • Create Batch Campaign
        POST
      • List Campaign Messages
        GET
      • Retrieve Campaign Details
        GET
  1. Campaigns

List Organization Campaigns

GET
https://api.ziett.co/c/v1/campaigns
Last modified:2026-03-22 10:48:32
Retrieve a paginated list of all batch message campaigns created by your organization. Use this endpoint to monitor the status and performance of your bulk sends.

Search (q)#

Keyword search that matches against:
Name: The human-readable name of the campaign.

🛠 Filtering options#

Filtering parameters support a single value or an array of values (e.g., status=COMPLETED&status=FAILED).
ParameterTypeDescription
statusenumCampaign state: PENDING, PROCESSING, COMPLETED, FAILED.
channel_typeenumPrimary channel: SMS, WHATSAPP.
tag_iduuidFilter campaigns targeting specific audience tags.
remitter_iduuidFilter by the assigned Sender ID (Remitter).
created_at__gedatetimeFilter by creation date (ISO 8601).
created_at__ledatetimeFilter by creation date (ISO 8601).

Pagination & Sorting#

Page Size: Paginate results using page and size (default 30, max 200).
Sorting: Sort by created_at or updated_at in asc or desc order.

Request

Authorization
API Key
Add parameter in header
X-API-KEY
Example:
X-API-KEY: ********************
or
Query Params

Responses

🟢200OK
application/json
Successful Response
Bodyapplication/json

🟠422Parameter Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.ziett.co/c/v1/campaigns?q=&size=30&page=1&order=desc&order_by=created_at&error_code=&status=&trigger_source=&channel_type=&tag_id=&sms_remitter_id=&created_at__ge=&created_at__le=' \
--header 'X-API-KEY: <api-key>'
Response Response Example
200 - Example 1
{
    "entries": [
        {
            "id": "string",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "created_at": "2019-08-24T14:15:22.123Z",
            "name": "string",
            "status": "DRAFT",
            "organization_id": "string",
            "billing_account_id": "string",
            "trigger_source": "API_CLIENT",
            "file_metadata_id": "string",
            "channel_type": "SMS",
            "sms_remitter_id": "string",
            "sms_remitter": {
                "name": "Ziett"
            },
            "content": "string",
            "total_estimated_recipients": 0,
            "scheduled_at": "2019-08-24T14:15:22.123Z",
            "processed_at": "2019-08-24T14:15:22.123Z",
            "completed_at": "2019-08-24T14:15:22.123Z",
            "error_code": "SYSTEM_DISPATCH_ERROR",
            "status_note": "string",
            "data": {
                "reason_of_pause": "string"
            }
        }
    ],
    "total": 0,
    "page": 1,
    "size": 1,
    "pages": 0
}
Modified at 2026-03-22 10:48:32
Previous
Retrieve Message Details
Next
Create Batch Campaign
Built with