Call Outcomes

The Call Outcomes API provides a simple interface to manage call outcomes.

The API allows you to read your call outcomes. You can retrieve a list of your call outcomes.

JSON format

NameTypeRead onlyDescription
idnumbertrueUnique identifier of the call outcome.
creator_idnumbertrueUnique identifier of the user who created the call outcome.
namestringtrueName of the call outcome.
created_atstringtrueDate and time of when the call outcome was created in UTC (ISO8601 format).
updated_atstringtrueDate and time of the last update in UTC (ISO8601 format).

Retrieve All Call Outcomes

GET /v2/call_outcomes

Returns all call outcomes available to the user, according to the parameters provided. Call outcomes are always sorted by id in ascending order.


pagenumberQueryfalsePage number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page. e.g. ?page=2
per_pagenumberQueryfalseNumber of records to return per page. Default limit is 25 and the maximum number that can be returned is 100. e.g. ?per_page=20

Allowed for

  • Agents

Using curl

curl -v -X GET \-H "Accept: application/json" \-H "Authorization: Bearer $ACCESS_TOKEN"

Example Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "items": [    {      "data": {        "contact_id": 2,        "role": "involved",        "created_at": "2014-08-27T16:32:56Z",        "updated_at": "2014-08-27T17:32:56Z"      },      "meta": {        "type": "associated_contact"      }    }  ],  "meta": {    "type": "collection",    "count": 1,    "links": {      "self": ""    }  }}