Fetch Campaigns Api
curl --request GET \
--url https://services.meetchase.ai/api/v1/campaigns \
--header 'X-API-Key: <api-key>'import requests
url = "https://services.meetchase.ai/api/v1/campaigns"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://services.meetchase.ai/api/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://services.meetchase.ai/api/v1/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://services.meetchase.ai/api/v1/campaigns"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://services.meetchase.ai/api/v1/campaigns")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://services.meetchase.ai/api/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"auto_enrich": false,
"auto_pilot_settings": {
"cancel_meeting": false,
"create_meeting": false,
"do_not_contact": true,
"do_not_respond": false,
"move_meeting": false,
"put_on_hold": true,
"send_email": false,
"send_reconnect_email": false,
"send_referral_email": false,
"unsuccessful_delivery": true
},
"created_at": "2023-11-05 17:26:49.244856",
"email_tracking": false,
"id": 1,
"include_disclaimer": true,
"link_tracking": false,
"meeting_duration": 30,
"name": "Lead Generation Campaign",
"status": "PENDING",
"test_mode": false,
"unsubscribe_mode": "one-click"
}
]Campaigns
Fetch Campaigns
Retrieves a list of campaigns associated with a specified organisation. This includes campaigns’ names, subjects, statuses, creation dates, and email tracking settings.
Path Parameters
organisation_id(int): The ID of the organisation for which campaigns are being fetched.
Headers
X-API-Key: API key for user authentication. Ensures that the request is made by an authorised user.
Response
- Returns a list of
Campaignobjects, each encapsulating details about a specific email campaign, including its ID, name, subject, creation date, status (e.g., pending, active, completed), and whether email tracking is enabled.
Errors
403 Forbidden: If the authenticated user is not a member of the specified organisation.404 Not Found: The campaign does not belong to the specified organisation.
GET
/
api
/
v1
/
campaigns
Fetch Campaigns Api
curl --request GET \
--url https://services.meetchase.ai/api/v1/campaigns \
--header 'X-API-Key: <api-key>'import requests
url = "https://services.meetchase.ai/api/v1/campaigns"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://services.meetchase.ai/api/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://services.meetchase.ai/api/v1/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://services.meetchase.ai/api/v1/campaigns"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://services.meetchase.ai/api/v1/campaigns")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://services.meetchase.ai/api/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"auto_enrich": false,
"auto_pilot_settings": {
"cancel_meeting": false,
"create_meeting": false,
"do_not_contact": true,
"do_not_respond": false,
"move_meeting": false,
"put_on_hold": true,
"send_email": false,
"send_reconnect_email": false,
"send_referral_email": false,
"unsuccessful_delivery": true
},
"created_at": "2023-11-05 17:26:49.244856",
"email_tracking": false,
"id": 1,
"include_disclaimer": true,
"link_tracking": false,
"meeting_duration": 30,
"name": "Lead Generation Campaign",
"status": "PENDING",
"test_mode": false,
"unsubscribe_mode": "one-click"
}
]Authorizations
Key used to authenticate user API requests.
Response
200 - application/json
Successful Response
Required string length:
1 - 63Manages the automation settings for a campaign's AI assistant.
Each setting determines whether the AI should handle a specific event
automatically (True) or flag it for manual human review (False). Think of
these as permissions for the AI to act on its own.
Show child attributes
Show child attributes
Example:
{
"cancel_meeting": false,
"create_meeting": false,
"do_not_contact": true,
"do_not_respond": false,
"move_meeting": false,
"put_on_hold": true,
"send_email": false,
"send_reconnect_email": false,
"send_referral_email": false,
"unsuccessful_delivery": true
}
Available options:
off, one-click, text