Skip to main content
GET
/
v1
/
call-log
cURL
curl --request GET \
  --url https://client-api.salesfinity.co/v1/call-log \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "_id": "<string>",
      "call_id": "<string>",
      "outcome": "answered",
      "direction": "inbound",
      "answered_by": "human",
      "duration": 123,
      "to": "<string>",
      "from": "<string>",
      "disposition": {
        "internal_id": 123,
        "external_id": "<string>",
        "external_name": "<string>"
      },
      "contact": {},
      "contact_list": {},
      "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
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.salesfinity.ai/llms.txt

Use this file to discover all available pages before exploring further.

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[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 contact name, company, and phone numbers

​
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

​
Response

Returns a JSON object containing the list of call logs with pagination metadata. 
{
  "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"
      },
      "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

FieldTypeDescription
_idstringUnique identifier
call_idstringUnique call identifier
outcomestringCall outcome (answered, no-answer, cancelled)
directionstringCall direction (inbound, outbound)
answered_bystringWho answered (human, machine_start)
durationnumberCall duration in seconds
tostringCalled phone number
fromstringCaller phone number
dispositionobjectDisposition details with internal_id
contactobjectContact information
contact_listobjectAssociated contact list
userobjectUser who made/received the call
recording_urlstringURL to call recording (if available)
notesstringCall notes
transcriptionstringCall transcription (if available)
summarystringAI-generated call summary (if available)
is_completedbooleanWhether the call is completed
started_atdateCall start time
ended_atdateCall end time
createdAtdateRecord creation time
updatedAtdateRecord 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[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 contact name, company, and phone numbers

Response

200 - application/json

A paginated list of call logs with metadata.

​
data
object[]
​
pagination
object