Skip to main content

​
Overview

The Campaign List webhook returns a paginated list of all campaigns in your PitchCRM account. Use page and limit to control pagination.

​
Endpoint

POST https://partner.api.v3.pitchcrm.com/v3/partner/webhook/campaign/list

​
Request Body

{
  "limit": 10,
  "page": 1
}

​
Field Reference

FieldTypeRequiredDescription
limitIntegerYesNumber of records per page. Maximum: 50
pageIntegerYesPage number to retrieve. Must be >= 1

​
Success Response

Status: 200 OK 
{
  "pageNo": 1,
  "pageSize": 10,
  "totalPages": 25,
  "totalRecords": 241,
  "filteredRecords": 1,
  "campaigns": [
    {
      "Id": 12345,
      "campaignName": "Spring Promo",
      "campaignDescription": "",
      "campaignType": 0,
      "campaignChannel": "email",
      "status": "scheduled",
      "statusColor": "#009202",
      "active": 1,
      "scheduleType": "scheduled",
      "scheduledOn": "2026-02-19T17:12:43.000Z",
      "scheduledTimeZone": "EST",
      "offset": "-05:00",
      "timeZoneLabel": "EST Eastern Time Zone",
      "step": "completed",
      "autoOnOff": 0,
      "autoResend": 0,
      "broadcastOn": "2026-02-19T17:12:43.000Z",
      "createdAt": "2026-02-10T15:43:45.000Z",
      "updatedAt": "2026-02-10T22:06:56.000Z",
      "broadcast": 1,
      "priority": 0,
      "reasonOrg": null,
      "reason": null
    }
  ]
}

​
Response Field Descriptions

FieldTypeDescription
pageNoIntegerCurrent page number
pageSizeIntegerNumber of records returned on this page
totalPagesIntegerTotal number of available pages
totalRecordsIntegerTotal campaigns in the account
filteredRecordsIntegerNumber of campaigns in the campaigns array
campaigns[].IdIntegerUnique campaign ID
campaigns[].campaignNameStringCampaign name
campaigns[].campaignDescriptionStringCampaign description
campaigns[].campaignTypeInteger0 = Static, 1 = Dynamic
campaigns[].campaignChannelStringemail or sms
campaigns[].statusStringCurrent campaign status (e.g. scheduled, completed)
campaigns[].statusColorStringHex color code for the status
campaigns[].activeInteger1 = Active, 0 = Deleted
campaigns[].scheduleTypeStringType of schedule
campaigns[].scheduledOnStringISO 8601 scheduled send datetime
campaigns[].scheduledTimeZoneStringTimezone code (e.g. EST)
campaigns[].offsetStringUTC offset (e.g. -05:00)
campaigns[].autoResendInteger1 = Auto-resend enabled, 0 = Disabled
campaigns[].broadcastOnStringISO 8601 broadcast datetime
campaigns[].createdAtStringISO 8601 creation datetime
campaigns[].updatedAtStringISO 8601 last updated datetime
campaigns[].broadcastInteger1 = Ready to send, 0 = Not ready
campaigns[].reasonStringFailure reason, if applicable

​
Error Responses

HTTP CodeError MessageDescription
401Invalid API credentialsx-api-key or x-api-secret is incorrect
403Unauthorized account accessx-account-id mismatch
429Rate limit exceeded. Try again later.More than 100 requests per minute
500Internal server errorUnexpected server-side issue