List campaigns

GET /campaigns

List campaigns

cURL

curl --request GET \
  --url https://api.pineyard.ai/campaigns \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "agentId": "<string>",
    "agentName": "<string>",
    "channel": "VOICE",
    "status": "<string>",
    "reservedConcurrency": 123,
    "variableMap": {},
    "startedAt": "<string>",
    "endedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "campaignTypeId": "<string>",
    "campaignTypeName": "<string>",
    "customExtractionKeys": [
      {
        "name": "<string>",
        "type": "string",
        "description": "<string>"
      }
    ],
    "effectiveExtractionKeys": [
      {
        "name": "<string>",
        "type": "string",
        "description": "<string>"
      }
    ],
    "notificationUserIds": [
      "<string>"
    ],
    "source": "CSV",
    "defaultCrmConnectionId": "<string>",
    "defaultCrmSegmentId": "<string>",
    "description": "<string>",
    "whatsappOutreachTemplateId": "<string>",
    "whatsappTemplateByMetric": null,
    "messageDeclinedLeads": true,
    "dailyMessageCap": 123,
    "outreachRules": [
      {
        "trigger": "MESSAGE_REPLY",
        "afterDays": 45,
        "condition": {
          "kind": "ai_interested",
          "describe": "<string>"
        },
        "conditions": [
          {
            "kind": "ai_interested",
            "describe": "<string>"
          }
        ],
        "match": "ALL",
        "action": "HAND_OFF"
      }
    ],
    "whatsappEnabled": true,
    "whatsappAgentTemplateIds": [
      "<string>"
    ],
    "whatsappPaymentLinkEnabled": true,
    "recoveryLinkEnabled": true,
    "whatsappAutomations": [
      {
        "key": "<string>",
        "label": "<string>",
        "detail": "<string>"
      }
    ],
    "workflowId": "<string>",
    "countryCode": "<string>",
    "phoneColumn": "<string>",
    "altPhoneColumns": [
      "<string>"
    ],
    "removeInvalidRows": true,
    "transliterateCalleeNames": true,
    "uploadId": "<string>",
    "timezone": "<string>",
    "scheduledStartAt": "<string>",
    "scheduledEndAt": "<string>",
    "dailyWindowStart": "<string>",
    "dailyWindowEnd": "<string>",
    "retryCount": 123,
    "cooldownMinutes": 123,
    "retryDelaysMinutes": [
      123
    ],
    "retryConcurrencyPercent": 123,
    "followupEnabled": true,
    "followupMaxAttempts": 123,
    "churnEnabled": true,
    "churnMaxAttempts": 123,
    "churnIntervalHours": 123,
    "churnDelaysHours": [
      123
    ],
    "goal": "<string>",
    "incompleteRetryEnabled": true,
    "incompleteRetryMaxAttempts": 123,
    "incompleteRetryIntervalMinutes": 123,
    "incompleteRetryDelaysMinutes": [
      123
    ],
    "incompleteCallSeconds": 123,
    "referralMaxDepth": 123,
    "skipRetryOnFirstVoicemail": true,
    "messageRetryEnabled": true,
    "messageRetryMaxAttempts": 123,
    "messageRetryIntervalSeconds": 123,
    "messageRetryDelaysSeconds": [
      123
    ],
    "messageRetryWindowSeconds": 123,
    "messageRetryTieredEnabled": true,
    "messageRetryTransientMaxAttempts": 123,
    "autoReseedEnabled": true,
    "briefFileName": "<string>",
    "briefUploadedAt": "<string>",
    "briefText": "<string>",
    "dailyDialCap": 123,
    "dialDays": [
      123
    ],
    "evaluationMetrics": [
      {
        "key": "<string>",
        "label": "<string>",
        "allowedValues": [
          "<string>"
        ],
        "prompt": "<string>",
        "builtin": true
      }
    ],
    "contactCount": 123,
    "receivedCalls": 123
  }
]

Required scope: campaigns.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Response

200

application/json

OK

id · string · required

name · string · required

agentId · string | null · required

agentName · string | null · required

channel · enum<string> · required

Available options: VOICE, WHATSAPP, VOICE_THEN_WHATSAPP, WHATSAPP_THEN_VOICE, CUSTOM, EMAIL

status · string · required

reservedConcurrency · number · required

variableMap · object · required

Show child attributes

startedAt · string | null · required

endedAt · string | null · required

createdAt · string · required

updatedAt · string · required

campaignTypeId · string | null · required

campaignTypeName · string | null · required

customExtractionKeys · object[] · required

Show child attributes

effectiveExtractionKeys · object[] · required

Show child attributes

notificationUserIds · string[] · required

source · enum<string> · required

Available options: CSV, CRM_MANUAL, CRM_WEBHOOK, API, INBOUND

defaultCrmConnectionId · string | null · required

defaultCrmSegmentId · string | null · required

description · string | null

whatsappOutreachTemplateId · string | null

whatsappTemplateByMetric · unknown

messageDeclinedLeads · boolean

dailyMessageCap · number | null

outreachRules · object[] | null

Maximum array length: 20

Show child attributes

whatsappEnabled · boolean

whatsappAgentTemplateIds · string[]

whatsappPaymentLinkEnabled · boolean

recoveryLinkEnabled · boolean

whatsappAutomations · object[]

Show child attributes

workflowId · string | null

countryCode · string | null

phoneColumn · string | null

altPhoneColumns · string[]

removeInvalidRows · boolean

transliterateCalleeNames · boolean

uploadId · string | null

timezone · string | null

scheduledStartAt · string | null

scheduledEndAt · string | null

dailyWindowStart · string | null

dailyWindowEnd · string | null

retryCount · number

cooldownMinutes · number

retryDelaysMinutes · number[]

retryConcurrencyPercent · number | null

followupEnabled · boolean

followupMaxAttempts · number

churnEnabled · boolean

churnMaxAttempts · number

churnIntervalHours · number

churnDelaysHours · number[]

goal · string | null

incompleteRetryEnabled · boolean

incompleteRetryMaxAttempts · number

incompleteRetryIntervalMinutes · number

incompleteRetryDelaysMinutes · number[]

incompleteCallSeconds · number

referralMaxDepth · number

skipRetryOnFirstVoicemail · boolean

messageRetryEnabled · boolean

messageRetryMaxAttempts · number

messageRetryIntervalSeconds · number

messageRetryDelaysSeconds · number[]

messageRetryWindowSeconds · number

messageRetryTieredEnabled · boolean

messageRetryTransientMaxAttempts · number

autoReseedEnabled · boolean

briefFileName · string | null

briefUploadedAt · string | null

briefText · string | null

dailyDialCap · number | null

dialDays · number[]

evaluationMetrics · object[]

Maximum array length: 12

Show child attributes

contactCount · number

receivedCalls · number