Skip to main content
GET
/
v1
/
follow-up
cURL
curl --request GET \
  --url https://client-api.salesfinity.co/v1/follow-up \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "_id": "<string>",
      "team": "<string>",
      "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": [],
      "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
}
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

​
Response

Returns a paginated array of follow-up tasks with the following fields:
  • _id - Unique identifier
  • team - Team ID
  • user - Assigned user
  • call_log - Associated call log ID
  • contact - Contact ID
  • company - Company ID
  • priority - Task priority: high, medium, or low
  • status - Task status: not_overdue, overdue, or completed
  • follow_up_date - Scheduled follow-up date
  • first_name - Contact’s first name
  • last_name - Contact’s last name
  • tags - Array of tags: timing, budget, competitor
  • touches - Number of contact attempts
  • context - Additional context or notes
  • is_archived - Whether the task is archived
  • createdAt - Creation timestamp
  • updatedAt - Last update timestamp

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer

Items per page

Required range: 1 <= x <= 100
​
sort
string

Sort field(s). Prefix with - for descending

Response

200 - application/json

Follow-up tasks retrieved successfully

​
data
object[]
​
total
integer
​
page
integer
​
next
integer | null