Look up TFU Live resources

Lists, one kind at a time, what a workflow’s settings can name in this sub-account: calendars (Find slots, Cancel appointment), tags (tag nodes), custom_fields (contact.custom.<id>), contact_fields (contact.<key>), pipelines and their stages (Move stage), and the team members and teams a Transfer can ring. A custom or contact field comes with its kind and options, which say what a Set field value or Collect information item saved there must be. These are the same lookups a save checks against. status unavailable means the lookup could not run, not that there are none. Required scope: `agents:read`. Required API key scope: `agents:read`.

GET

api

tfu-live-agents

{id}

resources

{kind}

cURL

curl --request GET \
  --url https://api.teamfollowup.ai/api/tfu-live-agents/{id}/resources/{kind} \
  --header 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.teamfollowup.ai/api/tfu-live-agents/{id}/resources/{kind}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.teamfollowup.ai/api/tfu-live-agents/{id}/resources/{kind}', 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/tfu-live-agents/{id}/resources/{kind}",
  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/tfu-live-agents/{id}/resources/{kind}"

	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/tfu-live-agents/{id}/resources/{kind}")

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,
  "data": {
    "kind": "calendars",
    "status": "available",
    "items": [
      {
        "id": "cal_consult01",
        "name": "Consultations",
        "calendarType": "round_robin",
        "isActive": true,
        "source": "gohighlevel"
      }
    ],
    "hasMore": false,
    "totalMatches": 1,
    "sources": {
      "gohighlevel": {
        "status": "available"
      }
    }
  }
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

string

required

The TFU Live agent id, with its tfu_live: prefix, as GET /api/tfu-live-agents returns it. Other agent ids are refused.

kind

enum<string>

required

What to look up.

Available options:

calendars,

tags,

custom_fields,

contact_fields,

pipelines,

reps,

teams

Query Parameters

locationId

string

required

The sub-account. It must belong to the agency, and be the credential’s own sub-account when the credential is limited to one.

query

string

A name to search for, or an exact id.

Maximum string length: 200

Response

Successful TFU Live response. Setup acceptance is not verified readiness or campaign activation.

success

any

required

data

object

required

Show child attributes

cURL

curl --request GET \
  --url https://api.teamfollowup.ai/api/tfu-live-agents/{id}/resources/{kind} \
  --header 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.teamfollowup.ai/api/tfu-live-agents/{id}/resources/{kind}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.teamfollowup.ai/api/tfu-live-agents/{id}/resources/{kind}', 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/tfu-live-agents/{id}/resources/{kind}",
  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/tfu-live-agents/{id}/resources/{kind}"

	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/tfu-live-agents/{id}/resources/{kind}")

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,
  "data": {
    "kind": "calendars",
    "status": "available",
    "items": [
      {
        "id": "cal_consult01",
        "name": "Consultations",
        "calendarType": "round_robin",
        "isActive": true,
        "source": "gohighlevel"
      }
    ],
    "hasMore": false,
    "totalMatches": 1,
    "sources": {
      "gohighlevel": {
        "status": "available"
      }
    }
  }
}

Developer setup

Agents

TFU Live

In-call Capabilities

Campaigns

Master agent

Phone Numbers

Caller ID

Voices

Projects

Calls

Contacts

Native Contacts

Native Calendar

Analytics

Billing

Look up TFU Live resources

Authorizations

Path Parameters

Query Parameters

Response