Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List call logs

Returns the phone system’s call logs, newest first (ordered by createdAt descending with id as the tiebreak, so paging is deterministic). Filter by an inclusive createdAt window (dateFrom/dateTo) or by the exact callSid delivered in a call webhook — the follow-up fetch for webhook consumers. Requires the calls scope.

GET/customer/phone-systems/{phoneSystemId}/call-logs
Authorization
X-API-KeyAPI key · headerrequired
API key (sk_phones_* prefix) for programmatic access
Path parameters
phoneSystemIdstring<uuid>required
Phone system identifier, discoverable via the accessible phone systems operation.
Query parameters
pageinteger
1-indexed page number.
min 1 · default: 1
pageSizeinteger
Rows per page; at most 100.
min 1 · max 100 · default: 25
dateFromstring<date-time>
Inclusive lower bound (ISO 8601 UTC) on the row creation time.
dateTostring<date-time>
Inclusive upper bound (ISO 8601 UTC) on the row creation time.
callSidstring
Exact-match filter on the call identifier from a webhook payload.
min length 1 · max length 64
Responses
200One page of call logs with the total row count for the filter.
dataobject[]required
Show properties
Array of object
callSidstringrequired
Call identifier, as delivered in webhook payloads.
createdAtstring<date-time>required
When the row was created; lists are ordered by this, descending.
directionstringrequired
Call direction.
Allowed:inboundoutboundinternal
durationinteger | anyrequired
Call duration in seconds.
Show properties
Any of:
integer
integer
any
any
endTimestring<date-time> | anyrequired
When the call ended.
Show properties
Any of:
string<date-time>
string<date-time>
any
any
fromstringrequired
Calling party.
fromNamestring | anyrequired
Caller name, when known.
Show properties
Any of:
string
string
any
any
idstring<uuid>required
Call log identifier — the callLogId carried by webhook payloads.
outcomestring | anyrequired
Call outcome (answered, missed, abandoned, voicemail, transferred, …).
Show properties
Any of:
string
string
any
any
parentCallSidstring | anyrequired
Parent call identifier when this row is a transferred or forwarded leg.
Show properties
Any of:
string
string
any
any
phoneSystemIdstring<uuid>required
Phone system this call belongs to.
recordingDurationinteger | anyrequired
Recording duration in seconds.
Show properties
Any of:
integer
integer
any
any
recordingSidstring | anyrequired
Recording identifier when the call was recorded — fetch via the recordings operations.
Show properties
Any of:
string
string
any
any
startTimestring<date-time> | anyrequired
When the call started.
Show properties
Any of:
string<date-time>
string<date-time>
any
any
statusstringrequired
Call status (completed, no-answer, busy, failed, canceled).
tostringrequired
Called party.
pageintegerrequired
min 1
pageSizeintegerrequired
min 1 · max 100
totalintegerrequired
min 0
totalPagesintegerrequired
min 0
400Validation failure: an unknown query parameter, a malformed date, or a pageSize above 100. Field problems are itemized in errors[].
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
401The API key is missing, malformed, expired, or revoked.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
403The key lacks the calls:read scope, or is not a tenant API key.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
404The phone system does not exist or is not covered by the key.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
Request
curl -X GET "https://api.steerphones.com/v1/customer/phone-systems/%3Cuuid%3E/call-logs" \
  -H "X-API-Key: YOUR_API_KEY"
Response
{
  "data": [
    {
      "callSid": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "direction": "inbound",
      "duration": 0,
      "endTime": "2024-01-01T00:00:00Z",
      "from": "string",
      "fromName": "string",
      "id": "<uuid>",
      "outcome": "string",
      "parentCallSid": "string",
      "phoneSystemId": "<uuid>",
      "recordingDuration": 0,
      "recordingSid": "string",
      "startTime": "2024-01-01T00:00:00Z",
      "status": "string",
      "to": "string"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "total": 0,
  "totalPages": 0
}