List follow-up tasks
curl --request GET \
--url https://client-api.salesfinity.co/v1/follow-up \
--header 'x-api-key: <api-key>'import requests
url = "https://client-api.salesfinity.co/v1/follow-up"
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://client-api.salesfinity.co/v1/follow-up', 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://client-api.salesfinity.co/v1/follow-up",
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://client-api.salesfinity.co/v1/follow-up"
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://client-api.salesfinity.co/v1/follow-up")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.salesfinity.co/v1/follow-up")
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{
"data": [
{
"_id": "<string>",
"team": "<string>",
"priority": "high",
"status": "not_overdue",
"follow_up_date": "2023-11-07T05:31:56Z",
"user": {
"_id": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"call_log": "<string>",
"contact": "<string>",
"company": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"tags": [
"timing"
],
"touches": 123,
"context": "<string>",
"is_archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"page": 123,
"next": 123
}{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}{
"message": "Too many requests",
"error": "Too Many Requests",
"statusCode": 429
}{
"message": "Internal server error",
"error": "Internal Server Error",
"statusCode": 500
}Follow-up Tasks
Get Follow-up Tasks
Returns all follow-up tasks for the team with pagination
GET
/
v1
/
follow-up
List follow-up tasks
curl --request GET \
--url https://client-api.salesfinity.co/v1/follow-up \
--header 'x-api-key: <api-key>'import requests
url = "https://client-api.salesfinity.co/v1/follow-up"
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://client-api.salesfinity.co/v1/follow-up', 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://client-api.salesfinity.co/v1/follow-up",
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://client-api.salesfinity.co/v1/follow-up"
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://client-api.salesfinity.co/v1/follow-up")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.salesfinity.co/v1/follow-up")
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{
"data": [
{
"_id": "<string>",
"team": "<string>",
"priority": "high",
"status": "not_overdue",
"follow_up_date": "2023-11-07T05:31:56Z",
"user": {
"_id": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"call_log": "<string>",
"contact": "<string>",
"company": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"tags": [
"timing"
],
"touches": 123,
"context": "<string>",
"is_archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"page": 123,
"next": 123
}{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}{
"message": "Too many requests",
"error": "Too Many Requests",
"statusCode": 429
}{
"message": "Internal server error",
"error": "Internal Server Error",
"statusCode": 500
}Returns all follow-up tasks for the team with pagination support. Follow-up tasks are created after calls to track pending actions and reminders.
Query Parameters
- page (optional, number): Page number for pagination. Default: 1
- limit (optional, number): Number of items per page. Min: 1, Max: 100
- sort (optional, string): Sort field(s). Prefix with ”-” for descending order. Default:
-createdAt- Example:
follow_up_date,-priority
- Example:
Response
Returns a paginated array of follow-up tasks with the following fields:_id- Unique identifierteam- Team IDuser- Assigned usercall_log- Associated call log IDcontact- Contact IDcompany- Company IDpriority- Task priority:high,medium, orlowstatus- Task status:not_overdue,overdue, orcompletedfollow_up_date- Scheduled follow-up datefirst_name- Contact’s first namelast_name- Contact’s last nametags- Array of tags:timing,budget,competitortouches- Number of contact attemptscontext- Additional context or notesis_archived- Whether the task is archivedcreatedAt- Creation timestampupdatedAt- Last update timestamp
Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings -> Connections & API. A missing or invalid key returns HTTP 403.
Query Parameters
Page number
Required range:
x >= 1Items per page
Required range:
1 <= x <= 100Sort field(s). Prefix with - for descending