calls

List /calls

List phone calls (PBX call history). Filters: updated_since for incremental sync, created_at/started_at/updated_at date ranges, direction, staff, client, lead, phone, is_personal, has_recording, uuid. recording is present only for keys with the call recordings permission. Transcription and AI summary are only in the detail endpoint. Response: items and pagination.

GET

/calls

List /calls

curl --request GET \
  --url 'https://default.hannacrm.app/api/v4/calls?query=%3Cstring%3E&page=123&per_page=123&filter%5Buuid%5D=%3Cstring%3E&filter%5Bupdated_since%5D=2023-11-07T05%3A31%3A56Z&filter%5Bcreated_since%5D=2023-11-07T05%3A31%3A56Z&filter%5Bcreated_at%5D=%3Cstring%3E&filter%5Bstarted_at%5D=%3Cstring%3E&filter%5Bupdated_at%5D=%3Cstring%3E&filter%5Bdirection%5D=%3Cstring%3E&filter%5Bstaff%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Bclient%5D=%3Cstring%3E&filter%5Blead%5D=%3Cstring%3E&filter%5Bphone%5D=%3Cstring%3E&filter%5Bis_personal%5D=123&filter%5Bhas_recording%5D=123&sort=%3Cstring%3E&fields=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "answered_at": "2023-11-07T05:31:56Z",
      "call_id": "<string>",
      "client": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "comment": "<string>",
      "contact": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "direction": "<string>",
      "duration_seconds": 123,
      "ended_at": "2023-11-07T05:31:56Z",
      "is_personal": true,
      "lead": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "lead_contact": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "phone_from": "<string>",
      "phone_to": "<string>",
      "queue_wait_seconds": 123,
      "reason": {
        "id": "<string>",
        "name": "<string>"
      },
      "staff": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "started_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    }
  ],
  "pagination": {
    "from": 123,
    "last_page": 123,
    "page": 123,
    "per_page": 123,
    "to": 123,
    "total": 123
  },
  "query": "<string>"
}

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Query Parameters

querystringquery

Optional search phrase matched against caller / destination phone number and provider call ID.

Minimum string length: 1

pageintegerquery

Page number (1-based).

Required range: 1 <= x

per_pageintegerquery

Results per page. limit is accepted as an alias.

Required range: 1 <= x <= 100

filter[uuid]stringquery

Call UUIDs. Fetch several known calls in one request.

filter[updated_since]stringquery

Calls changed (created, commented, reason set, recording synced, AI summary) at or after this ISO 8601 timestamp. Intended for incremental polling.

filter[created_since]stringquery

Calls logged at or after this ISO 8601 timestamp.

filter[created_at]stringquery

Logged date range (YYYY-MM-DD - YYYY-MM-DD).

filter[started_at]stringquery

Call start date range (YYYY-MM-DD - YYYY-MM-DD).

filter[updated_at]stringquery

Last change date range (YYYY-MM-DD - YYYY-MM-DD). Use updated_since for one-sided incremental polling.

filter[direction]stringquery

in or out.

filter[staff]string[]query

Staff UUIDs (the employee on the call).

filter[client]stringquery

Client UUIDs.

filter[lead]stringquery

Lead UUIDs.

filter[phone]stringquery

Phone number in any format; matches the caller or the destination. Fewer than 7 digits matches nothing.

filter[is_personal]integerquery

1 = personal call of the employee, 0 = business call.

Required range: 0 <= x <= 1

filter[has_recording]integerquery

1 = a recording file is stored in the CRM (downloadable), 0 = not stored.

Required range: 0 <= x <= 1

sortstringquery

Optional sort order, comma-separated; prefix a field with - for descending (e.g. sort=-updated_at); empty values sort last. Sortable fields: answered_at, call_id, created_at, direction, ended_at, phone_from, phone_to, started_at, uuid. Default when omitted: -pc_created_at,-pc_id.

fieldsstring[]query

Optional response field paths (dot notation for nested groups, e.g. billing_address.street; array fields are returned whole). Comma-separated string is also accepted. Identifier field is always included.

Response

Search results

itemsobject[]

Show child attributes

paginationobject

Show child attributes

querystring

Still need help? Ask the team