List campaign projects

cURL

curl --request GET \
  --url https://api.teamfollowup.ai/api/agent-builder/projects \
  --header 'Authorization: Bearer YOUR_API_KEY'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.teamfollowup.ai/api/agent-builder/projects', 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://api.teamfollowup.ai/api/agent-builder/projects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.teamfollowup.ai/api/agent-builder/projects"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/projects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "projects": [
    {
      "projectId": "64f2a8c8a2b3c4d5e6f7a8b9",
      "locationId": "loc_9f7a123",
      "businessName": "Acme Clinic",
      "agencyName": "Acme Agency",
      "campaignCount": 3
    }
  ]
}

{
  "success": false,
  "error": "VALIDATION",
  "message": "`name` is required when creating a campaign."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Forbidden",
  "message": "You do not have access to this project."
}

{
  "success": false,
  "error": "TooManyRequests",
  "message": "Too many requests, please try again later."
}

{
  "success": false,
  "error": "InternalError",
  "message": "Unexpected server error."
}

GET

api

agent-builder

projects

cURL

curl --request GET \
  --url https://api.teamfollowup.ai/api/agent-builder/projects \
  --header 'Authorization: Bearer YOUR_API_KEY'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.teamfollowup.ai/api/agent-builder/projects', 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://api.teamfollowup.ai/api/agent-builder/projects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.teamfollowup.ai/api/agent-builder/projects"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/projects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "projects": [
    {
      "projectId": "64f2a8c8a2b3c4d5e6f7a8b9",
      "locationId": "loc_9f7a123",
      "businessName": "Acme Clinic",
      "agencyName": "Acme Agency",
      "campaignCount": 3
    }
  ]
}

{
  "success": false,
  "error": "VALIDATION",
  "message": "`name` is required when creating a campaign."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Forbidden",
  "message": "You do not have access to this project."
}

{
  "success": false,
  "error": "TooManyRequests",
  "message": "Too many requests, please try again later."
}

{
  "success": false,
  "error": "InternalError",
  "message": "Unexpected server error."
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Response

Visible campaign projects.

success

boolean

required

projects

object[]

required

Show child attributes

Agents

Skills & Tools

Campaigns

Campaign Workflows

Calls

Analytics

Projects

Power Dialer

Contacts

Phone Numbers

Voices

GHL

Authorizations

Response