Retrieve Call Logs

cURL

curl --request GET \
  --url https://client-api.salesfinity.co/v1/call-log \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://client-api.salesfinity.co/v1/call-log', 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/call-log",
  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/call-log"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v1/call-log")

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>",
      "call_id": "<string>",
      "duration": 123,
      "to": "<string>",
      "from": "<string>",
      "disposition": {
        "internal_id": 123,
        "external_id": "<string>",
        "external_name": "<string>"
      },
      "contact": {},
      "contact_list": {},
      "source": {
        "type": "<string>",
        "id": "<string>",
        "name": "<string>"
      },
      "user": {
        "_id": "<string>",
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "recording_url": "<string>",
      "notes": "<string>",
      "transcription": "<string>",
      "summary": "<string>",
      "is_completed": true,
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "pages": 123
  }
}

GET

call-log

cURL

curl --request GET \
  --url https://client-api.salesfinity.co/v1/call-log \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://client-api.salesfinity.co/v1/call-log', 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/call-log",
  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/call-log"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v1/call-log")

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>",
      "call_id": "<string>",
      "duration": 123,
      "to": "<string>",
      "from": "<string>",
      "disposition": {
        "internal_id": 123,
        "external_id": "<string>",
        "external_name": "<string>"
      },
      "contact": {},
      "contact_list": {},
      "source": {
        "type": "<string>",
        "id": "<string>",
        "name": "<string>"
      },
      "user": {
        "_id": "<string>",
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "recording_url": "<string>",
      "notes": "<string>",
      "transcription": "<string>",
      "summary": "<string>",
      "is_completed": true,
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "pages": 123
  }
}

Retrieves a paginated list of call logs from the system. Use this endpoint to access call logs with metadata, such as timestamps, dispositions, and contact information.

Query Parameters

Pagination & Sorting

limit (optional, number): Number of items per page (default: 10, max: 100)
page (optional, number): The current page number to retrieve (default: 1)
sort (optional, string): Sort field with optional - prefix for descending order (default: -createdAt)

Filters

All filters are passed as query parameters with the filters[field] format.

Date Filters

filters[start_date] (optional, ISO 8601 date): Start of date range
filters[end_date] (optional, ISO 8601 date): End of date range

Call Properties

filters[outcome] (optional, string): Filter by call outcome
- answered - Call was answered
- no-answer - Call was not answered
- cancelled - Call was cancelled
filters[direction] (optional, string): Filter by call direction
- inbound - Incoming calls
- outbound - Outgoing calls
filters[min_duration] (optional, number): Minimum call duration in seconds
filters[max_duration] (optional, number): Maximum call duration in seconds
filters[has_recording] (optional, boolean): Filter by recording availability
- true - Only calls with recordings
- false - Only calls without recordings
filters[answered_by] (optional, string): Filter by who answered
- human - Answered by a person
- machine_start - Answered by voicemail/machine
filters[is_completed] (optional, boolean): Filter by completion status

Disposition Filters

filters[disposition_ids] (optional, number[]): Filter by disposition IDs. See Get Dispositions for available IDs.
filters[exclude_negative_dispositions] (optional, boolean): When true, only returns calls with positive dispositions (Meeting Set, Referral, Callback Later, etc.)

Entity Filters

filters[user_ids] (optional, string[]): Filter by user IDs
filters[contact_list_ids] (optional, string[]): Filter by contact list IDs
filters[contact_ids] (optional, string[]): Filter by contact IDs (the contact’s _id)
filters[crm_ids] (optional, string[]): Filter by CRM IDs (the contact’s crm_id)
filters[sequences] (optional, string[]): Filter by sequence IDs. See Get Sequences to discover available sequences.

Phone Number Filters

filters[from] (optional, string[]): Filter by caller phone numbers
filters[to] (optional, string[]): Filter by called phone numbers

Search

filters[search] (optional, string): Full-text search across the contact’s name, company, account, title and email, the to/from and contact phone numbers, and the call notes, summary and disposition/call purpose/call sentiment names. Call transcripts are not searched.

Example Requests

Basic request with date filter:

GET /v1/call-log?filters[start_date]=2024-01-01&filters[end_date]=2024-01-31

Filter by outcome and minimum duration:

GET /v1/call-log?filters[outcome]=answered&filters[min_duration]=60

Filter by disposition and recording:

GET /v1/call-log?filters[disposition_ids][]=1&filters[disposition_ids][]=4&filters[has_recording]=true

Search with multiple filters:

GET /v1/call-log?filters[search]=Acme&filters[direction]=outbound&page=1&limit=50

Filter by sequence:

GET /v1/call-log?filters[sequences][]=seq_12345&filters[sequences][]=seq_67890

Filter by CRM ID:

GET /v1/call-log?filters[crm_ids][]=00Q5f000001abcXYZ

Response

Returns a JSON object containing the list of call logs with pagination metadata.

Each call log includes both contact_list and source. contact_list is the dialing-queue list the call was placed from (its _id is the queue id). source identifies the original source list the call came from — for CSV lists, source.id is the CSV list id (which differs from the queue id). source.id/source.name are null for non-CSV lists. contact_list is unchanged and remains fully backward compatible.

{
  "data": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "call_id": "call_abc123",
      "outcome": "answered",
      "direction": "outbound",
      "answered_by": "human",
      "duration": 180,
      "to": "+1234567890",
      "from": "+1987654321",
      "disposition": {
        "internal_id": 1,
        "external_id": "meeting_set",
        "external_name": "Meeting Set"
      },
      "contact": {
        "first_name": "John",
        "last_name": "Doe",
        "company": "Acme Corp",
        "email": "[email protected]",
        "title": "VP of Sales"
      },
      "contact_list": {
        "_id": "507f1f77bcf86cd799439022",
        "name": "Q1 Prospects"
      },
      "source": {
        "type": "csv",
        "id": "507f1f77bcf86cd799439099",
        "name": "Q1 Prospects"
      },
      "user": {
        "_id": "507f1f77bcf86cd799439033",
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "[email protected]"
      },
      "recording_url": "https://recordings.example.com/call_abc123.mp3",
      "notes": "Great conversation, follow up next week",
      "is_completed": true,
      "started_at": "2024-01-15T14:30:00.000Z",
      "ended_at": "2024-01-15T14:33:00.000Z",
      "createdAt": "2024-01-15T14:33:00.000Z",
      "updatedAt": "2024-01-15T14:33:00.000Z"
    }
  ],
  "pagination": {
    "total": 150,
    "page": 1,
    "limit": 10,
    "pages": 15
  }
}

Response Fields

Field	Type	Description
`_id`	string	Unique identifier
`call_id`	string	Unique call identifier
`outcome`	string	Call outcome (answered, no-answer, cancelled)
`direction`	string	Call direction (inbound, outbound)
`answered_by`	string	Who answered (human, machine_start)
`duration`	number	Call duration in seconds
`to`	string	Called phone number
`from`	string	Caller phone number
`disposition`	object	Disposition details with internal_id
`contact`	object	Contact information
`contact_list`	object	The dialing-queue list (`ContactList`) the call was placed from; its `_id` is the queue id. Unchanged for backward compatibility.
`source`	object	The original source list the call came from. Additive; leaves `contact_list` untouched. Fields: `type` (integration source, e.g. `csv`/`hubspot`), `id` (the original source list id — the CSV list id for CSV lists, `null` for non-CSV), `name` (source list name). `id`/`name` are `null` when unresolved.
`user`	object	User who made/received the call
`recording_url`	string	URL to call recording (if available)
`notes`	string	Call notes
`transcription`	string	Call transcription (if available)
`summary`	string	AI-generated call summary (if available)
`is_completed`	boolean	Whether the call is completed
`started_at`	date	Call start time
`ended_at`	date	Call end time
`createdAt`	date	Record creation time
`updatedAt`	date	Record last update time

Authorizations

x-api-key

string

header

required

Query Parameters

limit

integer

default:10

Number of items per page (default: 10, max: 100)

Required range: 1 <= x <= 100

page

integer

default:1

The current page number (default: 1)

Required range: x >= 1

sort

string

Sort field with optional - prefix for descending order. Default: -createdAt

filters[start_date]

string<date-time>

Start of date range (ISO 8601)

filters[end_date]

string<date-time>

End of date range (ISO 8601)

filters[outcome]

enum<string>

Filter by call outcome

Available options:

answered,

no-answer,

cancelled

filters[direction]

enum<string>

Filter by call direction

Available options:

inbound,

outbound

filters[min_duration]

number

Minimum call duration in seconds

Required range: x >= 0

filters[max_duration]

number

Maximum call duration in seconds

Required range: x >= 0

filters[has_recording]

boolean

Filter by recording availability

filters[answered_by]

enum<string>

Filter by who answered the call

Available options:

human,

machine_start

filters[is_completed]

boolean

Filter by completion status

filters[disposition_ids]

integer[]

Filter by disposition IDs. See Get Dispositions for available IDs.

filters[exclude_negative_dispositions]

boolean

When true, only returns calls with positive dispositions (Meeting Set, Referral, Callback Later, etc.)

filters[user_ids]

string[]

Filter by user IDs

filters[contact_list_ids]

string[]

Filter by contact list IDs

filters[contact_ids]

string[]

Filter by contact IDs (the contact's _id)

filters[crm_ids]

string[]

Filter by CRM IDs (the contact's crm_id)

filters[sequences]

string[]

Filter by sequence IDs. See Get Sequences to discover available sequences.

filters[from]

string[]

Filter by caller phone numbers

filters[to]

string[]

Filter by called phone numbers

filters[search]

string

Full-text search across the contact's name, company, account, title and email, the to/from and contact phone numbers, and the call notes, summary and disposition/call purpose/call sentiment names. Call transcripts are not searched.

Response

200 - application/json

A paginated list of call logs with metadata.

data

object[]

Show child attributes

pagination

object

Show child attributes

Get All Users Get Call Log by ID

API Documentation

Contact Lists

Notes

Enrichment

Team & Call Logs

Scored Calls

Dispositions

Sequences

Snoozed Contacts

Follow-up Tasks

Custom Fields

Analytics

Webhooks

Query Parameters

Filters

Date Filters

Call Properties

Disposition Filters

Entity Filters

Phone Number Filters

Search

Example Requests

Response

Response Fields

Authorizations

Query Parameters

Response

​Query Parameters

​Pagination & Sorting

​Filters

Date Filters

Call Properties

Disposition Filters

Entity Filters

Phone Number Filters

Search

​Example Requests

​Response

​Response Fields

Authorizations

Query Parameters

Response

Query Parameters

Pagination & Sorting

Filters

Example Requests

Response

Response Fields