v1
latestOpenAPI 3.0.02026-08-061280285.2 KBCampaign APIs
This endpoint lists all campaigns created within Recruiterflow
get/api/external/campaign/list
Query parameters
items_per_pagestring
Number of records per page.
current_pagestring
The page number.
include_countstring
Count of total records
Headers
RF-Api-Keystring
Response
Auto generated using Swagger Inspector
{"stackTrail":"paths:/api/external/campaign/list:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"data":[{"bounces":0,"campaign_status_id":3,"created_by":{"email":"abc@def.com","first_name":"AB","id":2841,"last_name":"C","name":"ABC"},"errors":0,"id":5,"last_twenty_four_hour_count":0,"name":"Test Campaign","opens":0,"prospect_type_id":1,"replies":0,"schedules":0,"sends":0,"timezone":"(GMT+05:30) India Standard Time"},{"bounces":0,"campaign_status_id":3,"created_by":{"email":"abc@recruiterflow.com","first_name":"AB","id":3264,"last_name":"C","name":"AB C"},"errors":0,"id":1,"last_twenty_four_hour_count":0,"name":"Untitled campaign","opens":0,"prospect_type_id":1,"replies":0,"schedules":0,"sends":0,"timezone":"(GMT+05:30) India Standard Time"}],"total_items":2}}
Example response
{
"data": [
{
"bounces": 0,
"campaign_status_id": 3,
"created_by": {
"email": "abc@def.com",
"first_name": "AB",
"id": 2841,
"last_name": "C",
"name": "ABC"
},
"errors": 0,
"id": 5,
"last_twenty_four_hour_count": 0,
"name": "Test Campaign",
"opens": 0,
"prospect_type_id": 1,
"replies": 0,
"schedules": 0,
"sends": 0,
"timezone": "(GMT+05:30) India Standard Time"
},
{
"bounces": 0,
"campaign_status_id": 3,
"created_by": {
"email": "abc@recruiterflow.com",
"first_name": "AB",
"id": 3264,
"last_name": "C",
"name": "AB C"
},
"errors": 0,
"id": 1,
"last_twenty_four_hour_count": 0,
"name": "Untitled campaign",
"opens": 0,
"prospect_type_id": 1,
"replies": 0,
"schedules": 0,
"sends": 0,
"timezone": "(GMT+05:30) India Standard Time"
}
],
"total_items": 2
}