Visit Outcomes

The Visit Outcomes API provides a simple interface to retrieve visit outcomes.

Retrieve all visit outcomes

GET /v2/visit_outcomes

Returns all visits outcomes available to the user, according to the parameters provided.


Name Read Only Type Description
page false number Page number to start from. Page numbering starts at 1 and omitting the page parameter will return the first page. Maximum page that can be returned is 100
per_page false number Number of records to return per page. Maximum per_page value is _200_.

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": {        "id": 23296,        "name": "Interested",        "created_at": "2018-05-09T07:30:16.000Z",        "updated_at": "2018-05-09T07:30:16.000Z"      },      "meta": {        "type": "visit_outcome"      }    },    {      "data": {        "id": 23297,        "name": "Not Interested",        "created_at": "2018-05-09T07:30:16.000Z",        "updated_at": "2018-05-09T07:30:16.000Z"      },      "meta": {        "type": "visit_outcome"      }    }  ],  "meta": {    "type": "collection",    "count": 2,    "links": {    }  }}