List Campaigns

GET

https://api.vapi.ai/campaign

GET

/campaign

$ curl https://api.vapi.ai/campaign \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "results": [
3     {
4       "status": "scheduled",
5       "name": "Q2 Sales Campaign",
6       "id": "string",
7       "orgId": "string",
8       "createdAt": "2024-01-15T09:30:00Z",
9       "updatedAt": "2024-01-15T09:30:00Z",
10       "calls": {},
11       "callsCounterScheduled": 1.1,
12       "callsCounterQueued": 1.1,
13       "callsCounterInProgress": 1.1,
14       "callsCounterEndedVoicemail": 1.1,
15       "callsCounterEnded": 1.1,
16       "endedReason": "campaign.scheduled.ended-by-user",
17       "assistantId": "string",
18       "workflowId": "string",
19       "squadId": "string",
20       "phoneNumberId": "string",
21       "dialPlan": [
22         {
23           "phoneNumberId": "string",
24           "customers": [
25             {
26               "numberE164CheckEnabled": true,
27               "extension": "string",
28               "assistantOverrides": {
29                 "transcriber": {
30                   "provider": "assembly-ai",
31                   "language": "multi",
32                   "confidenceThreshold": 0.4,
33                   "formatTurns": true,
34                   "endOfTurnConfidenceThreshold": 0.7,
35                   "minEndOfTurnSilenceWhenConfident": 160,
36                   "wordFinalizationMaxWaitTime": 160,
37                   "maxTurnSilence": 400,
38                   "vadAssistedEndpointingEnabled": true,
39                   "speechModel": "universal-streaming-english",
40                   "realtimeUrl": "string",
41                   "wordBoost": [
42                     "string"
43                   ],
44                   "keytermsPrompt": [
45                     "string"
46                   ],
47                   "endUtteranceSilenceThreshold": 1.1,
48                   "disablePartialTranscripts": true,
49                   "fallbackPlan": {
50                     "transcribers": [
51                       {
52                         "provider": "assembly-ai",
53                         "language": "multi",
54                         "confidenceThreshold": 0.4,
55                         "formatTurns": true,
56                         "endOfTurnConfidenceThreshold": 0.7,
57                         "minEndOfTurnSilenceWhenConfident": 160,
58                         "wordFinalizationMaxWaitTime": 160,
59                         "maxTurnSilence": 400,
60                         "vadAssistedEndpointingEnabled": true,
61                         "speechModel": "universal-streaming-english",
62                         "realtimeUrl": "string",
63                         "wordBoost": [
64                           "string"
65                         ],
66                         "keytermsPrompt": [
67                           "string"
68                         ],
69                         "endUtteranceSilenceThreshold": 1.1,
70                         "disablePartialTranscripts": true
71                       }
72                     ]
73                   }
74                 },
75                 "model": {
76                   "messages": [
77                     {
78                       "content": "string",
79                       "role": "assistant"
80                     }
81                   ],
82                   "tools": [
83                     {
84                       "messages": [
85                         {
86                           "contents": [
87                             {}
88                           ],
89                           "type": "request-start",
90                           "blocking": false,
91                           "content": "string",
92                           "conditions": [
93                             {
94                               "operator": {},
95                               "param": {},
96                               "value": {}
97                             }
98                           ]
99                         }
100                       ],
101                       "type": "apiRequest",
102                       "method": "POST",
103                       "timeoutSeconds": 20,
104                       "credentialId": "550e8400-e29b-41d4-a716-446655440000",
105                       "encryptedPaths": [
106                         "string"
107                       ],
108                       "parameters": [
109                         {
110                           "key": "string",
111                           "value": {}
112                         }
113                       ],
114                       "name": "string",
115                       "description": "string",
116                       "url": "string",
117                       "body": {
118                         "type": "string",
119                         "items": {},
120                         "properties": {},
121                         "description": "string",
122                         "pattern": "string",
123                         "format": "date-time",
124                         "required": [
125                           "string"
126                         ],
127                         "enum": [
128                           "string"
129                         ],
130                         "title": "string"
131                       },
132                       "headers": {
133                         "type": "string",
134                         "items": {},
135                         "properties": {},
136                         "description": "string",
137                         "pattern": "string",
138                         "format": "date-time",
139                         "required": [
140                           "string"
141                         ],
142                         "enum": [
143                           "string"
144                         ],
145                         "title": "string"
146                       },
147                       "backoffPlan": {
148                         "type": "fixed",
149                         "maxRetries": 0,
150                         "baseDelaySeconds": 1,
151                         "excludedStatusCodes": [
152                           400,
153                           401,
154                           403,
155                           404
156                         ]
157                       },
158                       "variableExtractionPlan": {
159                         "schema": {},
160                         "aliases": [
161                           {
162                             "key": {},
163                             "value": {}
164                           }
165                         ]
166                       },
167                       "rejectionPlan": {
168                         "conditions": [
169                           "[{ type: \"regex\", regex: \"(?i)\\\\b(cancel|stop)\\\\b\", target: { role: \"user\" } }]"
170                         ]
171                       }
172                     }
173                   ],
174                   "toolIds": [
175                     "string"
176                   ],
177                   "knowledgeBase": {
178                     "provider": "custom-knowledge-base",
179                     "server": {
180                       "timeoutSeconds": 20,
181                       "credentialId": "550e8400-e29b-41d4-a716-446655440000",
182                       "staticIpAddressesEnabled": false,
183                       "encryptedPaths": [
184                         "string"
185                       ],
186                       "url": "string",
187                       "headers": {},
188                       "backoffPlan": {}
189                     }
190                   },
191                   "model": "claude-3-opus-20240229",
192                   "provider": "anthropic",
193                   "thinking": {
194                     "type": "enabled",
195                     "budgetTokens": 50500
196                   },
197                   "temperature": 1.1,
198                   "maxTokens": 5030,
199                   "emotionRecognitionEnabled": true,
200                   "numFastTurns": 1.1
201                 },
202                 "voice": {
203                   "cachingEnabled": true,
204                   "provider": "azure",
205                   "voiceId": "andrew",
206                   "chunkPlan": {
207                     "enabled": true,
208                     "minCharacters": 30,
209                     "punctuationBoundaries": "。",
210                     "formatPlan": {
211                       "enabled": true,
212                       "numberToDigitsCutoff": 2025,
213                       "replacements": [
214                         {}
215                       ],
216                       "formattersEnabled": "markdown"
217                     }
218                   },
219                   "speed": 1.1,
220                   "fallbackPlan": {
221                     "voices": [
222                       {
223                         "cachingEnabled": true,
224                         "provider": "azure",
225                         "voiceId": "andrew",
226                         "speed": 1.1,
227                         "chunkPlan": {},
228                         "oneOf": null
229                       }
230                     ]
231                   }
232                 },
233                 "firstMessage": "Hello! How can I help you today?",
234                 "firstMessageInterruptionsEnabled": false,
235                 "firstMessageMode": "assistant-speaks-first",
236                 "voicemailDetection": "off",
237                 "clientMessages": "conversation-update",
238                 "serverMessages": "assistant.started",
239                 "maxDurationSeconds": 600,
240                 "backgroundSound": "off",
241                 "modelOutputInMessagesEnabled": false,
242                 "transportConfigurations": [
243                   {
244                     "provider": "twilio",
245                     "timeout": 60,
246                     "record": false,
247                     "recordingChannels": "mono"
248                   }
249                 ],
250                 "observabilityPlan": {
251                   "provider": "langfuse",
252                   "tags": [
253                     "string"
254                   ],
255                   "promptName": "string",
256                   "promptVersion": 1.1,
257                   "traceName": "string",
258                   "metadata": {}
259                 },
260                 "credentials": [
261                   {
262                     "provider": "anthropic",
263                     "apiKey": "string",
264                     "name": "string"
265                   }
266                 ],
267                 "hooks": [
268                   {
269                     "on": "call.ending",
270                     "do": [
271                       {
272                         "type": "tool",
273                         "tool": {
274                           "messages": [
275                             {}
276                           ],
277                           "type": "apiRequest",
278                           "method": "POST",
279                           "timeoutSeconds": 20,
280                           "credentialId": "550e8400-e29b-41d4-a716-446655440000",
281                           "encryptedPaths": [
282                             "string"
283                           ],
284                           "parameters": [
285                             {
286                               "key": {},
287                               "value": {}
288                             }
289                           ],
290                           "name": "string",
291                           "description": "string",
292                           "url": "string",
293                           "body": {},
294                           "headers": {},
295                           "backoffPlan": {},
296                           "variableExtractionPlan": {},
297                           "rejectionPlan": {}
298                         },
299                         "toolId": "string"
300                       }
301                     ],
302                     "filters": [
303                       {
304                         "type": "oneOf",
305                         "key": "string",
306                         "oneOf": [
307                           "string"
308                         ]
309                       }
310                     ]
311                   }
312                 ],
313                 "tools:append": [
314                   {
315                     "messages": [
316                       {
317                         "contents": [
318                           {
319                             "type": "text",
320                             "text": "string",
321                             "language": "aa"
322                           }
323                         ],
324                         "type": "request-start",
325                         "blocking": false,
326                         "content": "string",
327                         "conditions": [
328                           {
329                             "operator": "eq",
330                             "param": "string",
331                             "value": "string"
332                           }
333                         ]
334                       }
335                     ],
336                     "type": "apiRequest",
337                     "method": "POST",
338                     "timeoutSeconds": 20,
339                     "credentialId": "550e8400-e29b-41d4-a716-446655440000",
340                     "encryptedPaths": [
341                       "string"
342                     ],
343                     "parameters": [
344                       {
345                         "key": "string",
346                         "value": {}
347                       }
348                     ],
349                     "name": "string",
350                     "description": "string",
351                     "url": "string",
352                     "body": {
353                       "type": "string",
354                       "items": {},
355                       "properties": {},
356                       "description": "string",
357                       "pattern": "string",
358                       "format": "date-time",
359                       "required": [
360                         "string"
361                       ],
362                       "enum": [
363                         "string"
364                       ],
365                       "title": "string"
366                     },
367                     "headers": {
368                       "type": "string",
369                       "items": {},
370                       "properties": {},
371                       "description": "string",
372                       "pattern": "string",
373                       "format": "date-time",
374                       "required": [
375                         "string"
376                       ],
377                       "enum": [
378                         "string"
379                       ],
380                       "title": "string"
381                     },
382                     "backoffPlan": {
383                       "type": "fixed",
384                       "maxRetries": 0,
385                       "baseDelaySeconds": 1,
386                       "excludedStatusCodes": [
387                         400,
388                         401,
389                         403,
390                         404
391                       ]
392                     },
393                     "variableExtractionPlan": {
394                       "schema": {
395                         "type": "string",
396                         "items": {},
397                         "properties": {},
398                         "description": "string",
399                         "pattern": "string",
400                         "format": "date-time",
401                         "required": [
402                           "string"
403                         ],
404                         "enum": [
405                           "string"
406                         ],
407                         "title": "string"
408                       },
409                       "aliases": [
410                         {
411                           "key": "string",
412                           "value": "string"
413                         }
414                       ]
415                     },
416                     "rejectionPlan": {
417                       "conditions": [
418                         {
419                           "type": "regex",
420                           "regex": "\\\\b(cancel|stop|wait)\\\\b - Matches whole words"
421                         }
422                       ]
423                     }
424                   }
425                 ],
426                 "variableValues": {},
427                 "name": "string",
428                 "voicemailMessage": "string",
429                 "endCallMessage": "string",
430                 "endCallPhrases": [
431                   "string"
432                 ],
433                 "compliancePlan": {
434                   "hipaaEnabled": true,
435                   "pciEnabled": {
436                     "pciEnabled": false
437                   },
438                   "securityFilterPlan": {
439                     "enabled": false,
440                     "filters": [
441                       {}
442                     ],
443                     "mode": "sanitize",
444                     "replacementText": "[FILTERED]"
445                   },
446                   "recordingConsentPlan": {
447                     "type": "stay-on-line",
448                     "message": "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.",
449                     "voice": {
450                       "cachingEnabled": true,
451                       "provider": "azure",
452                       "voiceId": "andrew",
453                       "chunkPlan": {
454                         "enabled": true,
455                         "minCharacters": 30,
456                         "punctuationBoundaries": [
457                           "。",
458                           "，",
459                           ".",
460                           "!",
461                           "?",
462                           ";",
463                           "،",
464                           "۔",
465                           "।",
466                           "॥",
467                           "|",
468                           "||",
469                           ",",
470                           ":"
471                         ],
472                         "formatPlan": {}
473                       },
474                       "speed": 1.1,
475                       "fallbackPlan": {
476                         "voices": {}
477                       }
478                     },
479                     "waitSeconds": 3
480                   }
481                 },
482                 "metadata": {},
483                 "backgroundSpeechDenoisingPlan": {
484                   "smartDenoisingPlan": {
485                     "enabled": true
486                   },
487                   "fourierDenoisingPlan": {
488                     "enabled": false,
489                     "mediaDetectionEnabled": true,
490                     "staticThreshold": -35,
491                     "baselineOffsetDb": -15,
492                     "windowSizeMs": 3000,
493                     "baselinePercentile": 85
494                   }
495                 },
496                 "analysisPlan": {
497                   "summaryPlan": {
498                     "messages": [
499                       {}
500                     ],
501                     "enabled": true,
502                     "timeoutSeconds": 1.1
503                   },
504                   "structuredDataPlan": {
505                     "messages": [
506                       {}
507                     ],
508                     "enabled": true,
509                     "schema": {
510                       "type": "string",
511                       "items": {},
512                       "properties": {},
513                       "description": "string",
514                       "pattern": "string",
515                       "format": "date-time",
516                       "required": [
517                         "string"
518                       ],
519                       "enum": [
520                         "string"
521                       ],
522                       "title": "string"
523                     },
524                     "timeoutSeconds": 1.1
525                   },
526                   "successEvaluationPlan": {
527                     "rubric": "NumericScale",
528                     "messages": [
529                       {}
530                     ],
531                     "enabled": true,
532                     "timeoutSeconds": 1.1
533                   },
534                   "minMessagesThreshold": 1.1,
535                   "structuredDataMultiPlan": [
536                     {
537                       "key": "string",
538                       "plan": {
539                         "messages": [
540                           {}
541                         ],
542                         "enabled": true,
543                         "schema": {
544                           "type": {},
545                           "items": {},
546                           "properties": {},
547                           "description": {},
548                           "pattern": {},
549                           "format": {},
550                           "required": {},
551                           "enum": {},
552                           "title": {}
553                         },
554                         "timeoutSeconds": 1.1
555                       }
556                     }
557                   ],
558                   "outcomeIds": [
559                     "string"
560                   ]
561                 },
562                 "artifactPlan": {
563                   "recordingEnabled": true,
564                   "recordingFormat": "wav;l16",
565                   "recordingUseCustomStorageEnabled": true,
566                   "videoRecordingEnabled": false,
567                   "fullMessageHistoryEnabled": false,
568                   "pcapEnabled": true,
569                   "pcapS3PathPrefix": "/pcaps",
570                   "pcapUseCustomStorageEnabled": true,
571                   "loggingEnabled": true,
572                   "loggingUseCustomStorageEnabled": true,
573                   "transcriptPlan": {
574                     "enabled": true,
575                     "assistantName": "string",
576                     "userName": "string"
577                   },
578                   "recordingPath": "string",
579                   "structuredOutputIds": [
580                     "string"
581                   ],
582                   "structuredOutputs": [
583                     {
584                       "name": "string",
585                       "schema": {
586                         "type": "string",
587                         "items": {},
588                         "properties": {},
589                         "description": "string",
590                         "pattern": "string",
591                         "format": "date-time",
592                         "required": [
593                           "string"
594                         ],
595                         "enum": [
596                           "string"
597                         ],
598                         "title": "string"
599                       },
600                       "type": "ai",
601                       "regex": "string",
602                       "model": {
603                         "provider": "openai",
604                         "model": "gpt-5.4",
605                         "temperature": 1.1,
606                         "maxTokens": 5030
607                       },
608                       "compliancePlan": {
609                         "forceStoreOnHipaaEnabled": false
610                       },
611                       "description": "string",
612                       "assistantIds": [
613                         "string"
614                       ],
615                       "workflowIds": [
616                         "string"
617                       ]
618                     }
619                   ],
620                   "scorecardIds": [
621                     "string"
622                   ],
623                   "scorecards": [
624                     {
625                       "metrics": [
626                         {
627                           "structuredOutputId": "string",
628                           "conditions": [
629                             {}
630                           ]
631                         }
632                       ],
633                       "name": "string",
634                       "description": "string",
635                       "assistantIds": [
636                         "string"
637                       ]
638                     }
639                   ],
640                   "loggingPath": "string"
641                 },
642                 "startSpeakingPlan": {
643                   "waitSeconds": 0.4,
644                   "smartEndpointingPlan": {
645                     "provider": "vapi"
646                   },
647                   "customEndpointingRules": [
648                     {
649                       "type": "assistant",
650                       "regex": "string",
651                       "regexOptions": [
652                         {
653                           "type": "ignore-case",
654                           "enabled": true
655                         }
656                       ],
657                       "timeoutSeconds": 1.1
658                     }
659                   ],
660                   "transcriptionEndpointingPlan": {
661                     "onPunctuationSeconds": 0.1,
662                     "onNoPunctuationSeconds": 1.5,
663                     "onNumberSeconds": 0.5
664                   },
665                   "smartEndpointingEnabled": false
666                 },
667                 "stopSpeakingPlan": {
668                   "numWords": 0,
669                   "voiceSeconds": 0.2,
670                   "backoffSeconds": 1,
671                   "acknowledgementPhrases": [
672                     "i understand",
673                     "i see",
674                     "i got it",
675                     "i hear you",
676                     "im listening",
677                     "im with you",
678                     "right",
679                     "okay",
680                     "ok",
681                     "sure",
682                     "alright",
683                     "got it",
684                     "understood",
685                     "yeah",
686                     "yes",
687                     "uh-huh",
688                     "mm-hmm",
689                     "gotcha",
690                     "mhmm",
691                     "ah",
692                     "yeah okay",
693                     "yeah sure"
694                   ],
695                   "interruptionPhrases": [
696                     "stop",
697                     "shut",
698                     "up",
699                     "enough",
700                     "quiet",
701                     "silence",
702                     "but",
703                     "dont",
704                     "not",
705                     "no",
706                     "hold",
707                     "wait",
708                     "cut",
709                     "pause",
710                     "nope",
711                     "nah",
712                     "nevermind",
713                     "never",
714                     "bad",
715                     "actually"
716                   ]
717                 },
718                 "monitorPlan": {
719                   "listenEnabled": false,
720                   "listenAuthenticationEnabled": false,
721                   "controlEnabled": false,
722                   "controlAuthenticationEnabled": false,
723                   "monitorIds": [
724                     "123e4567-e89b-12d3-a456-426614174000"
725                   ]
726                 },
727                 "credentialIds": [
728                   "string"
729                 ],
730                 "server": {
731                   "timeoutSeconds": 20,
732                   "credentialId": "550e8400-e29b-41d4-a716-446655440000",
733                   "staticIpAddressesEnabled": false,
734                   "encryptedPaths": [
735                     "string"
736                   ],
737                   "url": "string",
738                   "headers": {},
739                   "backoffPlan": {
740                     "type": "fixed",
741                     "maxRetries": 0,
742                     "baseDelaySeconds": 1,
743                     "excludedStatusCodes": [
744                       400,
745                       401,
746                       403,
747                       404
748                     ]
749                   }
750                 },
751                 "keypadInputPlan": {
752                   "enabled": true,
753                   "timeoutSeconds": 1.1,
754                   "delimiters": "#"
755                 }
756               },
757               "number": "string",
758               "sipUri": "string",
759               "name": "string",
760               "email": "string",
761               "externalId": "string"
762             }
763           ]
764         }
765       ],
766       "schedulePlan": {
767         "earliestAt": "2024-01-15T09:30:00Z",
768         "latestAt": "2024-01-15T09:30:00Z"
769       },
770       "customers": [
771         {
772           "numberE164CheckEnabled": true,
773           "extension": "string",
774           "assistantOverrides": {
775             "transcriber": {
776               "provider": "assembly-ai",
777               "language": "multi",
778               "confidenceThreshold": 0.4,
779               "formatTurns": true,
780               "endOfTurnConfidenceThreshold": 0.7,
781               "minEndOfTurnSilenceWhenConfident": 160,
782               "wordFinalizationMaxWaitTime": 160,
783               "maxTurnSilence": 400,
784               "vadAssistedEndpointingEnabled": true,
785               "speechModel": "universal-streaming-english",
786               "realtimeUrl": "string",
787               "wordBoost": [
788                 "string"
789               ],
790               "keytermsPrompt": [
791                 "string"
792               ],
793               "endUtteranceSilenceThreshold": 1.1,
794               "disablePartialTranscripts": true,
795               "fallbackPlan": {
796                 "transcribers": [
797                   {
798                     "provider": "assembly-ai",
799                     "language": "multi",
800                     "confidenceThreshold": 0.4,
801                     "formatTurns": true,
802                     "endOfTurnConfidenceThreshold": 0.7,
803                     "minEndOfTurnSilenceWhenConfident": 160,
804                     "wordFinalizationMaxWaitTime": 160,
805                     "maxTurnSilence": 400,
806                     "vadAssistedEndpointingEnabled": true,
807                     "speechModel": "universal-streaming-english",
808                     "realtimeUrl": "string",
809                     "wordBoost": [
810                       "string"
811                     ],
812                     "keytermsPrompt": [
813                       "string"
814                     ],
815                     "endUtteranceSilenceThreshold": 1.1,
816                     "disablePartialTranscripts": true
817                   }
818                 ]
819               }
820             },
821             "model": {
822               "messages": [
823                 {
824                   "content": "string",
825                   "role": "assistant"
826                 }
827               ],
828               "tools": [
829                 {
830                   "messages": [
831                     {
832                       "contents": [
833                         {
834                           "type": {},
835                           "text": {},
836                           "language": {}
837                         }
838                       ],
839                       "type": "request-start",
840                       "blocking": false,
841                       "content": "string",
842                       "conditions": [
843                         {
844                           "operator": "eq",
845                           "param": "string",
846                           "value": "string"
847                         }
848                       ]
849                     }
850                   ],
851                   "type": "apiRequest",
852                   "method": "POST",
853                   "timeoutSeconds": 20,
854                   "credentialId": "550e8400-e29b-41d4-a716-446655440000",
855                   "encryptedPaths": [
856                     "string"
857                   ],
858                   "parameters": [
859                     {
860                       "key": "string",
861                       "value": {}
862                     }
863                   ],
864                   "name": "string",
865                   "description": "string",
866                   "url": "string",
867                   "body": {
868                     "type": "string",
869                     "items": {},
870                     "properties": {},
871                     "description": "string",
872                     "pattern": "string",
873                     "format": "date-time",
874                     "required": [
875                       "string"
876                     ],
877                     "enum": [
878                       "string"
879                     ],
880                     "title": "string"
881                   },
882                   "headers": {
883                     "type": "string",
884                     "items": {},
885                     "properties": {},
886                     "description": "string",
887                     "pattern": "string",
888                     "format": "date-time",
889                     "required": [
890                       "string"
891                     ],
892                     "enum": [
893                       "string"
894                     ],
895                     "title": "string"
896                   },
897                   "backoffPlan": {
898                     "type": "fixed",
899                     "maxRetries": 0,
900                     "baseDelaySeconds": 1,
901                     "excludedStatusCodes": [
902                       400,
903                       401,
904                       403,
905                       404
906                     ]
907                   },
908                   "variableExtractionPlan": {
909                     "schema": {
910                       "type": {},
911                       "items": {},
912                       "properties": {},
913                       "description": {},
914                       "pattern": {},
915                       "format": {},
916                       "required": {},
917                       "enum": {},
918                       "title": {}
919                     },
920                     "aliases": [
921                       {
922                         "key": "string",
923                         "value": "string"
924                       }
925                     ]
926                   },
927                   "rejectionPlan": {
928                     "conditions": [
929                       {
930                         "type": "regex",
931                         "regex": "\\\\b(cancel|stop|wait)\\\\b - Matches whole words"
932                       }
933                     ]
934                   }
935                 }
936               ],
937               "toolIds": [
938                 "string"
939               ],
940               "knowledgeBase": {
941                 "provider": "custom-knowledge-base",
942                 "server": {
943                   "timeoutSeconds": 20,
944                   "credentialId": "550e8400-e29b-41d4-a716-446655440000",
945                   "staticIpAddressesEnabled": false,
946                   "encryptedPaths": [
947                     "string"
948                   ],
949                   "url": "string",
950                   "headers": {},
951                   "backoffPlan": {
952                     "type": "fixed",
953                     "maxRetries": 0,
954                     "baseDelaySeconds": 1,
955                     "excludedStatusCodes": [
956                       400,
957                       401,
958                       403,
959                       404
960                     ]
961                   }
962                 }
963               },
964               "model": "claude-3-opus-20240229",
965               "provider": "anthropic",
966               "thinking": {
967                 "type": "enabled",
968                 "budgetTokens": 50500
969               },
970               "temperature": 1.1,
971               "maxTokens": 5030,
972               "emotionRecognitionEnabled": true,
973               "numFastTurns": 1.1
974             },
975             "voice": {
976               "cachingEnabled": true,
977               "provider": "azure",
978               "voiceId": "andrew",
979               "chunkPlan": {
980                 "enabled": true,
981                 "minCharacters": 30,
982                 "punctuationBoundaries": "。",
983                 "formatPlan": {
984                   "enabled": true,
985                   "numberToDigitsCutoff": 2025,
986                   "replacements": [
987                     {
988                       "type": {},
989                       "replaceAllEnabled": {},
990                       "key": {},
991                       "value": {}
992                     }
993                   ],
994                   "formattersEnabled": "markdown"
995                 }
996               },
997               "speed": 1.1,
998               "fallbackPlan": {
999                 "voices": [
1000                   {
1001                     "cachingEnabled": true,
1002                     "provider": "azure",
1003                     "voiceId": "andrew",
1004                     "speed": 1.1,
1005                     "chunkPlan": {
1006                       "enabled": true,
1007                       "minCharacters": 30,
1008                       "punctuationBoundaries": [
1009                         "。",
1010                         "，",
1011                         ".",
1012                         "!",
1013                         "?",
1014                         ";",
1015                         "،",
1016                         "۔",
1017                         "।",
1018                         "॥",
1019                         "|",
1020                         "||",
1021                         ",",
1022                         ":"
1023                       ],
1024                       "formatPlan": {}
1025                     },
1026                     "oneOf": null
1027                   }
1028                 ]
1029               }
1030             },
1031             "firstMessage": "Hello! How can I help you today?",
1032             "firstMessageInterruptionsEnabled": false,
1033             "firstMessageMode": "assistant-speaks-first",
1034             "voicemailDetection": "off",
1035             "clientMessages": "conversation-update",
1036             "serverMessages": "assistant.started",
1037             "maxDurationSeconds": 600,
1038             "backgroundSound": "off",
1039             "modelOutputInMessagesEnabled": false,
1040             "transportConfigurations": [
1041               {
1042                 "provider": "twilio",
1043                 "timeout": 60,
1044                 "record": false,
1045                 "recordingChannels": "mono"
1046               }
1047             ],
1048             "observabilityPlan": {
1049               "provider": "langfuse",
1050               "tags": [
1051                 "string"
1052               ],
1053               "promptName": "string",
1054               "promptVersion": 1.1,
1055               "traceName": "string",
1056               "metadata": {}
1057             },
1058             "credentials": [
1059               {
1060                 "provider": "anthropic",
1061                 "apiKey": "string",
1062                 "name": "string"
1063               }
1064             ],
1065             "hooks": [
1066               {
1067                 "on": "call.ending",
1068                 "do": [
1069                   {
1070                     "type": "tool",
1071                     "tool": {
1072                       "messages": [
1073                         {
1074                           "contents": {},
1075                           "type": {},
1076                           "blocking": false,
1077                           "content": {},
1078                           "conditions": {}
1079                         }
1080                       ],
1081                       "type": "apiRequest",
1082                       "method": "POST",
1083                       "timeoutSeconds": 20,
1084                       "credentialId": "550e8400-e29b-41d4-a716-446655440000",
1085                       "encryptedPaths": [
1086                         "string"
1087                       ],
1088                       "parameters": [
1089                         {
1090                           "key": "string",
1091                           "value": {}
1092                         }
1093                       ],
1094                       "name": "string",
1095                       "description": "string",
1096                       "url": "string",
1097                       "body": {
1098                         "type": {},
1099                         "items": {},
1100                         "properties": {},
1101                         "description": {},
1102                         "pattern": {},
1103                         "format": {},
1104                         "required": {},
1105                         "enum": {},
1106                         "title": {}
1107                       },
1108                       "headers": {
1109                         "type": {},
1110                         "items": {},
1111                         "properties": {},
1112                         "description": {},
1113                         "pattern": {},
1114                         "format": {},
1115                         "required": {},
1116                         "enum": {},
1117                         "title": {}
1118                       },
1119                       "backoffPlan": {
1120                         "type": "fixed",
1121                         "maxRetries": 0,
1122                         "baseDelaySeconds": 1,
1123                         "excludedStatusCodes": [
1124                           400,
1125                           401,
1126                           403,
1127                           404
1128                         ]
1129                       },
1130                       "variableExtractionPlan": {
1131                         "schema": {},
1132                         "aliases": {}
1133                       },
1134                       "rejectionPlan": {
1135                         "conditions": "[{ type: \"regex\", regex: \"(?i)\\\\b(cancel|stop)\\\\b\", target: { role: \"user\" } }]"
1136                       }
1137                     },
1138                     "toolId": "string"
1139                   }
1140                 ],
1141                 "filters": [
1142                   {
1143                     "type": "oneOf",
1144                     "key": "string",
1145                     "oneOf": [
1146                       "string"
1147                     ]
1148                   }
1149                 ]
1150               }
1151             ],
1152             "tools:append": [
1153               {
1154                 "messages": [
1155                   {
1156                     "contents": [
1157                       {
1158                         "type": "text",
1159                         "text": "string",
1160                         "language": "aa"
1161                       }
1162                     ],
1163                     "type": "request-start",
1164                     "blocking": false,
1165                     "content": "string",
1166                     "conditions": [
1167                       {
1168                         "operator": "eq",
1169                         "param": "string",
1170                         "value": "string"
1171                       }
1172                     ]
1173                   }
1174                 ],
1175                 "type": "apiRequest",
1176                 "method": "POST",
1177                 "timeoutSeconds": 20,
1178                 "credentialId": "550e8400-e29b-41d4-a716-446655440000",
1179                 "encryptedPaths": [
1180                   "string"
1181                 ],
1182                 "parameters": [
1183                   {
1184                     "key": "string",
1185                     "value": {}
1186                   }
1187                 ],
1188                 "name": "string",
1189                 "description": "string",
1190                 "url": "string",
1191                 "body": {
1192                   "type": "string",
1193                   "items": {},
1194                   "properties": {},
1195                   "description": "string",
1196                   "pattern": "string",
1197                   "format": "date-time",
1198                   "required": [
1199                     "string"
1200                   ],
1201                   "enum": [
1202                     "string"
1203                   ],
1204                   "title": "string"
1205                 },
1206                 "headers": {
1207                   "type": "string",
1208                   "items": {},
1209                   "properties": {},
1210                   "description": "string",
1211                   "pattern": "string",
1212                   "format": "date-time",
1213                   "required": [
1214                     "string"
1215                   ],
1216                   "enum": [
1217                     "string"
1218                   ],
1219                   "title": "string"
1220                 },
1221                 "backoffPlan": {
1222                   "type": "fixed",
1223                   "maxRetries": 0,
1224                   "baseDelaySeconds": 1,
1225                   "excludedStatusCodes": [
1226                     400,
1227                     401,
1228                     403,
1229                     404
1230                   ]
1231                 },
1232                 "variableExtractionPlan": {
1233                   "schema": {
1234                     "type": "string",
1235                     "items": {},
1236                     "properties": {},
1237                     "description": "string",
1238                     "pattern": "string",
1239                     "format": "date-time",
1240                     "required": [
1241                       "string"
1242                     ],
1243                     "enum": [
1244                       "string"
1245                     ],
1246                     "title": "string"
1247                   },
1248                   "aliases": [
1249                     {
1250                       "key": "string",
1251                       "value": "string"
1252                     }
1253                   ]
1254                 },
1255                 "rejectionPlan": {
1256                   "conditions": [
1257                     {
1258                       "type": "regex",
1259                       "regex": "\\\\b(cancel|stop|wait)\\\\b - Matches whole words"
1260                     }
1261                   ]
1262                 }
1263               }
1264             ],
1265             "variableValues": {},
1266             "name": "string",
1267             "voicemailMessage": "string",
1268             "endCallMessage": "string",
1269             "endCallPhrases": [
1270               "string"
1271             ],
1272             "compliancePlan": {
1273               "hipaaEnabled": true,
1274               "pciEnabled": {
1275                 "pciEnabled": false
1276               },
1277               "securityFilterPlan": {
1278                 "enabled": false,
1279                 "filters": [
1280                   {}
1281                 ],
1282                 "mode": "sanitize",
1283                 "replacementText": "[FILTERED]"
1284               },
1285               "recordingConsentPlan": {
1286                 "type": "stay-on-line",
1287                 "message": "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.",
1288                 "voice": {
1289                   "cachingEnabled": true,
1290                   "provider": "azure",
1291                   "voiceId": "andrew",
1292                   "chunkPlan": {
1293                     "enabled": true,
1294                     "minCharacters": 30,
1295                     "punctuationBoundaries": "。",
1296                     "formatPlan": {}
1297                   },
1298                   "speed": 1.1,
1299                   "fallbackPlan": {
1300                     "voices": [
1301                       {}
1302                     ]
1303                   }
1304                 },
1305                 "waitSeconds": 3
1306               }
1307             },
1308             "metadata": {},
1309             "backgroundSpeechDenoisingPlan": {
1310               "smartDenoisingPlan": {
1311                 "enabled": true
1312               },
1313               "fourierDenoisingPlan": {
1314                 "enabled": false,
1315                 "mediaDetectionEnabled": true,
1316                 "staticThreshold": -35,
1317                 "baselineOffsetDb": -15,
1318                 "windowSizeMs": 3000,
1319                 "baselinePercentile": 85
1320               }
1321             },
1322             "analysisPlan": {
1323               "summaryPlan": {
1324                 "messages": [
1325                   {}
1326                 ],
1327                 "enabled": true,
1328                 "timeoutSeconds": 1.1
1329               },
1330               "structuredDataPlan": {
1331                 "messages": [
1332                   {}
1333                 ],
1334                 "enabled": true,
1335                 "schema": {
1336                   "type": "string",
1337                   "items": {},
1338                   "properties": {},
1339                   "description": "string",
1340                   "pattern": "string",
1341                   "format": "date-time",
1342                   "required": [
1343                     "string"
1344                   ],
1345                   "enum": [
1346                     "string"
1347                   ],
1348                   "title": "string"
1349                 },
1350                 "timeoutSeconds": 1.1
1351               },
1352               "successEvaluationPlan": {
1353                 "rubric": "NumericScale",
1354                 "messages": [
1355                   {}
1356                 ],
1357                 "enabled": true,
1358                 "timeoutSeconds": 1.1
1359               },
1360               "minMessagesThreshold": 1.1,
1361               "structuredDataMultiPlan": [
1362                 {
1363                   "key": "string",
1364                   "plan": {
1365                     "messages": [
1366                       {}
1367                     ],
1368                     "enabled": true,
1369                     "schema": {
1370                       "type": "string",
1371                       "items": {},
1372                       "properties": {},
1373                       "description": "string",
1374                       "pattern": "string",
1375                       "format": "date-time",
1376                       "required": [
1377                         "string"
1378                       ],
1379                       "enum": [
1380                         "string"
1381                       ],
1382                       "title": "string"
1383                     },
1384                     "timeoutSeconds": 1.1
1385                   }
1386                 }
1387               ],
1388               "outcomeIds": [
1389                 "string"
1390               ]
1391             },
1392             "artifactPlan": {
1393               "recordingEnabled": true,
1394               "recordingFormat": "wav;l16",
1395               "recordingUseCustomStorageEnabled": true,
1396               "videoRecordingEnabled": false,
1397               "fullMessageHistoryEnabled": false,
1398               "pcapEnabled": true,
1399               "pcapS3PathPrefix": "/pcaps",
1400               "pcapUseCustomStorageEnabled": true,
1401               "loggingEnabled": true,
1402               "loggingUseCustomStorageEnabled": true,
1403               "transcriptPlan": {
1404                 "enabled": true,
1405                 "assistantName": "string",
1406                 "userName": "string"
1407               },
1408               "recordingPath": "string",
1409               "structuredOutputIds": [
1410                 "string"
1411               ],
1412               "structuredOutputs": [
1413                 {
1414                   "name": "string",
1415                   "schema": {
1416                     "type": "string",
1417                     "items": {},
1418                     "properties": {},
1419                     "description": "string",
1420                     "pattern": "string",
1421                     "format": "date-time",
1422                     "required": [
1423                       "string"
1424                     ],
1425                     "enum": [
1426                       "string"
1427                     ],
1428                     "title": "string"
1429                   },
1430                   "type": "ai",
1431                   "regex": "string",
1432                   "model": {
1433                     "provider": "openai",
1434                     "model": "gpt-5.4",
1435                     "temperature": 1.1,
1436                     "maxTokens": 5030
1437                   },
1438                   "compliancePlan": {
1439                     "forceStoreOnHipaaEnabled": false
1440                   },
1441                   "description": "string",
1442                   "assistantIds": [
1443                     "string"
1444                   ],
1445                   "workflowIds": [
1446                     "string"
1447                   ]
1448                 }
1449               ],
1450               "scorecardIds": [
1451                 "string"
1452               ],
1453               "scorecards": [
1454                 {
1455                   "metrics": [
1456                     {
1457                       "structuredOutputId": "string",
1458                       "conditions": [
1459                         {}
1460                       ]
1461                     }
1462                   ],
1463                   "name": "string",
1464                   "description": "string",
1465                   "assistantIds": [
1466                     "string"
1467                   ]
1468                 }
1469               ],
1470               "loggingPath": "string"
1471             },
1472             "startSpeakingPlan": {
1473               "waitSeconds": 0.4,
1474               "smartEndpointingPlan": {
1475                 "provider": "vapi"
1476               },
1477               "customEndpointingRules": [
1478                 {
1479                   "type": "assistant",
1480                   "regex": "string",
1481                   "regexOptions": [
1482                     {
1483                       "type": "ignore-case",
1484                       "enabled": true
1485                     }
1486                   ],
1487                   "timeoutSeconds": 1.1
1488                 }
1489               ],
1490               "transcriptionEndpointingPlan": {
1491                 "onPunctuationSeconds": 0.1,
1492                 "onNoPunctuationSeconds": 1.5,
1493                 "onNumberSeconds": 0.5
1494               },
1495               "smartEndpointingEnabled": false
1496             },
1497             "stopSpeakingPlan": {
1498               "numWords": 0,
1499               "voiceSeconds": 0.2,
1500               "backoffSeconds": 1,
1501               "acknowledgementPhrases": [
1502                 "i understand",
1503                 "i see",
1504                 "i got it",
1505                 "i hear you",
1506                 "im listening",
1507                 "im with you",
1508                 "right",
1509                 "okay",
1510                 "ok",
1511                 "sure",
1512                 "alright",
1513                 "got it",
1514                 "understood",
1515                 "yeah",
1516                 "yes",
1517                 "uh-huh",
1518                 "mm-hmm",
1519                 "gotcha",
1520                 "mhmm",
1521                 "ah",
1522                 "yeah okay",
1523                 "yeah sure"
1524               ],
1525               "interruptionPhrases": [
1526                 "stop",
1527                 "shut",
1528                 "up",
1529                 "enough",
1530                 "quiet",
1531                 "silence",
1532                 "but",
1533                 "dont",
1534                 "not",
1535                 "no",
1536                 "hold",
1537                 "wait",
1538                 "cut",
1539                 "pause",
1540                 "nope",
1541                 "nah",
1542                 "nevermind",
1543                 "never",
1544                 "bad",
1545                 "actually"
1546               ]
1547             },
1548             "monitorPlan": {
1549               "listenEnabled": false,
1550               "listenAuthenticationEnabled": false,
1551               "controlEnabled": false,
1552               "controlAuthenticationEnabled": false,
1553               "monitorIds": [
1554                 "123e4567-e89b-12d3-a456-426614174000"
1555               ]
1556             },
1557             "credentialIds": [
1558               "string"
1559             ],
1560             "server": {
1561               "timeoutSeconds": 20,
1562               "credentialId": "550e8400-e29b-41d4-a716-446655440000",
1563               "staticIpAddressesEnabled": false,
1564               "encryptedPaths": [
1565                 "string"
1566               ],
1567               "url": "string",
1568               "headers": {},
1569               "backoffPlan": {
1570                 "type": "fixed",
1571                 "maxRetries": 0,
1572                 "baseDelaySeconds": 1,
1573                 "excludedStatusCodes": [
1574                   400,
1575                   401,
1576                   403,
1577                   404
1578                 ]
1579               }
1580             },
1581             "keypadInputPlan": {
1582               "enabled": true,
1583               "timeoutSeconds": 1.1,
1584               "delimiters": "#"
1585             }
1586           },
1587           "number": "string",
1588           "sipUri": "string",
1589           "name": "string",
1590           "email": "string",
1591           "externalId": "string"
1592         }
1593       ]
1594     }
1595   ],
1596   "metadata": {
1597     "itemsPerPage": 1.1,
1598     "totalItems": 1.1,
1599     "currentPage": 1.1,
1600     "itemsBeyondRetention": true,
1601     "createdAtLe": "2024-01-15T09:30:00Z",
1602     "createdAtGe": "2024-01-15T09:30:00Z"
1603   }
1604 }

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Query parameters

idstringOptional

statusenumOptional

Allowed values:

pagedoubleOptional>=1

This is the page number to return. Defaults to 1.

sortOrderenumOptional

This is the sort order for pagination. Defaults to 'DESC'.

Allowed values:

limitdoubleOptional0-1000

This is the maximum number of items to return. Defaults to 100.

createdAtGtdatetimeOptional

This will return items where the createdAt is greater than the specified value.

createdAtLtdatetimeOptional

This will return items where the createdAt is less than the specified value.

createdAtGedatetimeOptional

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLedatetimeOptional

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGtdatetimeOptional

This will return items where the updatedAt is greater than the specified value.

updatedAtLtdatetimeOptional

This will return items where the updatedAt is less than the specified value.

updatedAtGedatetimeOptional

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLedatetimeOptional

This will return items where the updatedAt is less than or equal to the specified value.

Response

resultslist of objects

metadataobject

$	curl https://api.vapi.ai/campaign \
>	-H "Authorization: Bearer <token>"