CRM Integration API

The CRM Integration API enables you to view a list of CRM integration licenses in your VoIP account.

API calls

Click on each call to view the endpoint, method, and request example.

Parameters

The table shows the possible parameters available for CRM integration requests.

Key Description Type Min/Max/Default
account_id Required. Hosted PBX VoIP account ID. string N/A
auth_token Required. Unique authentication string. string N/A
pagination Indicates if pagination is enabled. If this parameter is set to false, it returns all available results at once. boolean true

Get licenses

Returns a list of CRM integration licenses for a specific a VoIP account.

Method and endpoint

GET api/crm/integration/licenses

Request

https://{SERVER}/crm/integration/licenses?auth_token={​{​HostedPBX_auth_token}}&account_id={​{​HostedPBX_Account_ID}}

Sample error response

{
    "status": "error",
    "error": ""
}

Sample success response

NOTE: "input" contains the input parameters provided, "output contains a mix of API results"

{
    "status": "success",
    "input": {},
    "output": [
    {
        "reference": "zoho-crm",
        "amount": 10,
},
]
}