WOworkiz
Calls

Retrieve a list of Calls

Changed on

Beta: Breaking changes may occur without notice.

Retrieves a paginated list of Calls, newest first by default. When no date filter is provided, results default to the last 30 days. Pass dateProperty, dateOperator, and date together to override this default. Dates are in the account timezone. The applied range is always returned in the dateRange field of the response. Only the first 10000 results of a query can be paged through.

get/v2/calls

Request

Query parameters

pageSizenumber
Example:100

Number of records to return per page.

pagenumber
Example:1

The page index.

field'createdAt' | 'duration'

The field to sort results by. Must be combined with order. Defaults to createdAt.

order'ASC' | 'DESC'

The sort direction. Must be combined with field. Defaults to DESC.

directionstring[]

Filter by call direction. Can be passed multiple times.

status'answered' | 'missed' | 'voicemail' | 'active' | 'geniusAnswering'

Filter by call outcome, with the same meaning as the Calls page status filter. Accepts a single value. answered also returns calls with a status of geniusAnswering, and missed also returns calls with a status of voicemail.

userIdstring[]

Filter by the user who answered or placed the ID (prefix USR-). Can be passed multiple times.

clientIdstring[]

Filter by client ID (prefix CL-). Can be passed multiple times.

jobIdstring[]

Filter by linked job ID (prefix JOB-). Can be passed multiple times.

leadIdstring[]

Filter by linked lead ID (prefix LD-). Can be passed multiple times.

adGroupIdstring[]

Filter by ad group ID (prefix AG-). Can be passed multiple times.

tagsstring[]

Filter by tag ID (prefix TAG-). Can be passed multiple times; returns calls that have any of the given tags.

sentimentstring[]

Filter by the AI sentiment of the call. Can be passed multiple times.

intentstring[]

Filter by the AI detected intent of the caller. Can be passed multiple times.

durationOperator'under' | 'over'

Comparison for the duration filter. Must be combined with duration. under returns calls shorter than duration, over returns calls longer than it.

durationnumber
Example:300

The call duration boundary in seconds, used with durationOperator. The boundary itself is excluded (e.g. over with 300 returns calls longer than 5 minutes).

dateProperty'created'

The call date field to apply the date filter to. Must be combined with dateOperator and date. When these date filter params are omitted, results default to the last 30 days.

dateOperator'prev' | 'next' | 'between'

Comparison operator for the date filter. Must be combined with dateProperty and date.

datestring

Date value(s) for the filter, in the account timezone. Format depends on dateOperator: prev / next accept a single date (YYYY-MM-DD); between accepts two dates separated by _ (YYYY-MM-DD_YYYY-MM-DD). Both ends are inclusive.

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

A paginated list of Calls, with the date range the results are limited to.

pageSizenumber

The maximum number of items returned per page.

pagenumber

The current page number.

totalResultsnumber

The total number of results.

hasMoreboolean

Whether there are more results.

Example response

{
  "pageSize": 10,
  "page": 1,
  "totalResults": 50,
  "hasMore": true,
  "data": [
    {
      "id": "CAL-5e2a9c7b1d4f8e36",
      "direction": "inbound",
      "from": "2125550199",
      "to": "2125550100",
      "callMaskingNumber": "2125550142",
      "duration": 125,
      "status": "answered",
      "hasRecording": true,
      "flowName": "Main Flow",
      "adGroupId": "AG-71b8d7310acbf8cc",
      "clientId": "CL-2d1f8b3a9c7e6f50",
      "clientName": "Jane Smith",
      "jobId": "JOB-6a0e4d2b7f9c1e38",
      "leadId": "LD-4c8b2e6f1a9d3e70",
      "answeredByUserId": "USR-38c1ee5c4efa38a4",
      "answeredByUserName": "Jane Smith",
      "calledByUserId": "USR-38c1ee5c4efa38a4",
      "calledByUserName": "John Doe",
      "tags": [
        "TAG-16a94b03317f6e64"
      ],
      "insights": {
        "sentiment": "positive",
        "intent": "booking",
        "dispatcherScore": 82,
        "objection": "price",
        "pricingDiscussed": true
      },
      "updatedAt": "2025-01-13 13:39:10",
      "createdAt": "2025-01-13 13:36:46"
    }
  ],
  "dateRange": {
    "dateProperty": "created",
    "from": "2025-01-13",
    "to": "2025-01-14"
  }
}

Changes