MENU navbar-image
bash javascript php

Introduction

This documentation aims to provide all the information you need to work with our API.

Base URL

https://app.hipcall.com

Authenticating requests

Authenticate requests to this API's endpoints by sending an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Call

List all Calls

requires authentication

This endpoint let you list calls. You can use embed, sort, search and filter feature at this endpoint.

Direction enum

Call resource has a direction field with integer type.

key description
1 Inbound
2 Outbound
3 Internal

Channel type enum

Hipcall plans to add web widget for call directly from your website until that channel_type always return 1 ( number ) and channel_id means number's id.

key description
1 Number
2 Web widget (coming soon)

Caller type enum

key description
1 Contact
2 User

Callee type enum

key description
1 Contact
2 User
3 Greeting (IVR)
4 Team (Queue)
null Hangup

Missing call reason enum

key description
1 out_of_business_hours
3 abandoned
2 short_abandoned
4 callback

Important note on record_url

This URL will be expired in 60 minutes. It isn't a good idea to store this URL in your database.

Hangup by enum

Call resource has a hangup_by field with integer type.

key description
1 User
2 Contact
3 System

Important note on record_url

This URL will be expired in 60 minutes. It isn't a good idea to store this URL in your database.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/cdrs" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://app.hipcall.com/api/v20211124/cdrs"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/cdrs',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 29
vary: Origin
 

{
    "data": [
        {
            "resource_type": "cdr",
            "uuid": "caedfd1b-25ec-447e-ad87-3b7eb3d358ea",
            "direction": 1,
            "user_id": 1,
            "contact_id": 0,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2022-10-18T13:35:05+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2022-10-18T13:35:43+0000",
            "call_duration": 38,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101",
            "record_url": null,
            "hangup_by": 2
        },
        {
            "resource_type": "cdr",
            "uuid": "5fbca0b5-1d2f-4d23-b3da-19dcd200de75",
            "direction": 1,
            "user_id": 2,
            "contact_id": 0,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2022-10-18T13:35:05+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2022-10-18T13:35:11+0000",
            "call_duration": 6,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101",
            "record_url": null,
            "hangup_by": 3
        },
        {
            "resource_type": "cdr",
            "uuid": "07d40e97-ad97-456f-a8dd-6a8219f0551f",
            "direction": 1,
            "user_id": 1,
            "contact_id": 0,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2022-10-18T13:35:05+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2022-10-18T13:35:39+0000",
            "call_duration": 34,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101",
            "record_url": null,
            "hangup_by": 3
        },
        {
            "resource_type": "cdr",
            "uuid": "c35dc94b-9373-4a0d-9cb0-535df44e3ec7",
            "direction": 1,
            "user_id": 2,
            "contact_id": 0,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2022-10-18T13:35:05+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2022-10-18T13:43:56+0000",
            "call_duration": 531,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101",
            "record_url": null,
            "hangup_by": 3
        },
        {
            "resource_type": "cdr",
            "uuid": "48e4084f-04f1-449e-96e6-ce3447b0d9e1",
            "direction": 1,
            "user_id": 1,
            "contact_id": 0,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2022-10-18T13:35:05+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2022-10-18T13:43:28+0000",
            "call_duration": 503,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101",
            "record_url": null,
            "hangup_by": 2
        },
        {
            "resource_type": "cdr",
            "uuid": "098623e2-8c10-4fcb-86ce-a563f4e4d7f6",
            "direction": 1,
            "user_id": 1,
            "contact_id": 0,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2022-10-18T13:35:05+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2022-10-18T13:43:02+0000",
            "call_duration": 477,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101",
            "record_url": null,
            "hangup_by": 2
        },
        {
            "resource_type": "cdr",
            "uuid": "a373c1d2-95c7-4f2d-8f7f-9d195a30f73e",
            "direction": 1,
            "user_id": 2,
            "contact_id": 0,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2022-10-18T13:35:05+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2022-10-18T13:40:01+0000",
            "call_duration": 296,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101",
            "record_url": null,
            "hangup_by": 3
        },
        {
            "resource_type": "cdr",
            "uuid": "f76e3a47-2bea-4613-a8a4-dfec3a2a4ef7",
            "direction": 1,
            "user_id": 1,
            "contact_id": 0,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2022-10-18T13:35:05+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2022-10-18T13:36:05+0000",
            "call_duration": 60,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101",
            "record_url": null,
            "hangup_by": 2
        },
        {
            "resource_type": "cdr",
            "uuid": "b63c7255-b56a-44dc-bbd9-5ae41fb9d210",
            "direction": 1,
            "user_id": 1,
            "contact_id": 0,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2022-10-18T13:35:05+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2022-10-18T13:43:24+0000",
            "call_duration": 499,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101",
            "record_url": null,
            "hangup_by": 3
        },
        {
            "resource_type": "cdr",
            "uuid": "b69086e8-8bcc-49cd-ae8f-19d4a9de3a42",
            "direction": 2,
            "user_id": 1,
            "contact_id": 0,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2022-10-18T13:35:05+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2022-10-18T13:39:29+0000",
            "call_duration": 264,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 2,
            "caller_number": "+908508850000",
            "callee_id": 1,
            "callee_type": 1,
            "callee_number": "1015",
            "record_url": null,
            "hangup_by": 2
        }
    ],
    "links": {
        "first": "https://app.hipcall.com/api/v20211124/cdrs?page=1",
        "last": null,
        "prev": null,
        "next": "https://app.hipcall.com/api/v20211124/cdrs?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://app.hipcall.com/api/v20211124/cdrs",
        "per_page": "10",
        "to": 10
    }
}
 

Request      

GET api/v20211124/cdrs

URL Parameters

yyyy  integer  

The year of the call.

mm  integer  

The month of the call.

dd  integer  

The day of the call.

id  string  

The UUID of the call.

Body Parameters

q  string optional  

optional Search at caller_number, callee_number. Example ?q=497788123123.

embed  string optional  

The title of the post. No-example.

sort  string optional  

optional Field to sort by. Defaults to 'started_at'. Sortable fields: started_at and call_duration. Example ?sort=started_at,-call_duration.

direction  string optional  

optional Filter by direction field. Supported params: 1, inbound, 2, outbound, 3, internal. Example ?direction=inbound,outbound.

users  string optional  

optional Filter by users field. Add users' ids. Example ?users=1 or ?users=1,4,5.

missing_call  string optional  

optional Filter by missing_call field. Supported param: true or false. Example ?missing_call=true.

missing_call_reason  string optional  

optional Filter by missing_call_reason field. Supported params: 1, out_of_business_hours, 2, short_abandoned, 3, abandoned, 4, callback. Example ?missing_call_reason=1,2 or ?missing_call_reason=callback.

Retrieve a Call

requires authentication

Use this endpoint to retrieve a Call data. You can use embed feature at this endpoint.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/cdrs/2021/11/25/caedfd1b-25ec-447e-ad87-3b7eb3d358ea" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://app.hipcall.com/api/v20211124/cdrs/2021/11/25/caedfd1b-25ec-447e-ad87-3b7eb3d358ea"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/cdrs/2021/11/25/caedfd1b-25ec-447e-ad87-3b7eb3d358ea',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 28
vary: Origin
 

{
    "data": {
        "resource_type": "cdr",
        "uuid": "caedfd1b-25ec-447e-ad87-3b7eb3d358ea",
        "direction": 1,
        "user_id": 1,
        "contact_id": 0,
        "channel_type": 1,
        "channel_id": 1,
        "started_at": "2022-10-18T13:35:05+0000",
        "answered_at": null,
        "bridged_at": null,
        "ended_at": "2022-10-18T13:35:43+0000",
        "call_duration": 38,
        "first_touch_duration": 0,
        "missing_call": false,
        "missing_call_reason": 0,
        "caller_id": 1,
        "caller_type": 1,
        "caller_number": "+905326202911",
        "callee_id": 2,
        "callee_type": 3,
        "callee_number": "101",
        "record_url": null,
        "hangup_by": 2
    }
}
 

Request      

GET api/v20211124/cdrs/{yyyy}/{mm}/{dd}/{uuid}

URL Parameters

yyyy  integer  

Cdr year.

mm  integer  

Cdr month.

dd  integer  

Cdr day.

uuid  string optional  

uuid required CDR's uuid.

Body Parameters

embed  string optional  

Extension

List all Extensions

requires authentication

This endpoint let you list extensions. You can use sort, search and filter feature at this endpoint.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/extensions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://app.hipcall.com/api/v20211124/extensions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/extensions',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 25
vary: Origin
 

{
    "data": [
        {
            "resource_type": "extension",
            "id": 1,
            "number": "1001",
            "target_id": 1,
            "target_type": "user",
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "extension",
            "id": 2,
            "number": "1002",
            "target_id": 2,
            "target_type": "user",
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "extension",
            "id": 4,
            "number": "101",
            "target_id": 1,
            "target_type": "greeting",
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "extension",
            "id": 5,
            "number": "102",
            "target_id": 2,
            "target_type": "greeting",
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "extension",
            "id": 3,
            "number": "300",
            "target_id": 1,
            "target_type": "team",
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        }
    ],
    "links": {
        "first": "https://app.hipcall.com/api/v20211124/extensions?page=1",
        "last": "https://app.hipcall.com/api/v20211124/extensions?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://app.hipcall.com/api/v20211124/extensions?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://app.hipcall.com/api/v20211124/extensions",
        "per_page": 10,
        "to": 5,
        "total": 5
    }
}
 

Request      

GET api/v20211124/extensions

Body Parameters

q  string optional  

optional Search at number. Example ?q=497788123123.

sort  string optional  

optional Field to sort by. Defaults to 'created_at'. Sortable fields: number, created_at and target_type. Example ?sort=target_type,number.

target  string optional  

optional Filter by target field. Supported params: user, team, greeting. Example ?target=inbound,team.

Retrieve an Extension

requires authentication

Use this endpoint to retrieve an Extension data.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/extensions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.hipcall.com/api/v20211124/extensions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/extensions/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 24
vary: Origin
 

{
    "data": {
        "resource_type": "extension",
        "id": 1,
        "number": "1001",
        "target_id": 1,
        "target_type": "user",
        "created_at": "2022-10-18T13:35:05+0000",
        "updated_at": "2022-10-18T13:35:05+0000"
    }
}
 

Request      

GET api/v20211124/extensions/{id}

URL Parameters

id  integer  

The ID of the Extension.

Greeting

List all Greetings (IVRs)

requires authentication

This endpoint let you list greetings.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/greetings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.hipcall.com/api/v20211124/greetings"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/greetings',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 23
vary: Origin
 

{
    "data": [
        {
            "resource_type": "greeting",
            "id": 1,
            "name": "Out of business hours",
            "direct_dial_extension": false,
            "timeout": 0,
            "max_input_try_count": 0,
            "state": "active"
        },
        {
            "resource_type": "greeting",
            "id": 2,
            "name": "Welcome to Microsoft",
            "direct_dial_extension": true,
            "timeout": 0,
            "max_input_try_count": 3,
            "state": "active"
        }
    ],
    "links": {
        "first": "https://app.hipcall.com/api/v20211124/greetings?page=1",
        "last": "https://app.hipcall.com/api/v20211124/greetings?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://app.hipcall.com/api/v20211124/greetings?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://app.hipcall.com/api/v20211124/greetings",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/v20211124/greetings

Retrieve a Greeting (IVR)

requires authentication

Use this endpoint to retrieve a Greeting (IVR) data.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/greetings/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.hipcall.com/api/v20211124/greetings/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/greetings/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 22
vary: Origin
 

{
    "data": {
        "resource_type": "greeting",
        "id": 1,
        "name": "Out of business hours",
        "direct_dial_extension": false,
        "timeout": 0,
        "max_input_try_count": 0,
        "state": "active"
    }
}
 

Request      

GET api/v20211124/greetings/{id}

URL Parameters

id  integer  

The ID of the Greeting (IVR).

Number

List all Numbers

requires authentication

This endpoint let you list numbers.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/numbers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.hipcall.com/api/v20211124/numbers"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/numbers',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 21
vary: Origin
 

{
    "data": [
        {
            "resource_type": "number",
            "id": 1,
            "name": "Turkey Support Number",
            "number": "+908503902777"
        }
    ],
    "links": {
        "first": "https://app.hipcall.com/api/v20211124/numbers?page=1",
        "last": "https://app.hipcall.com/api/v20211124/numbers?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://app.hipcall.com/api/v20211124/numbers?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://app.hipcall.com/api/v20211124/numbers",
        "per_page": 10,
        "to": 1,
        "total": 1
    }
}
 

Request      

GET api/v20211124/numbers

Retrieve a Number

requires authentication

Use this endpoint to retrieve a Number data.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/numbers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.hipcall.com/api/v20211124/numbers/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/numbers/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 20
vary: Origin
 

{
    "data": {
        "resource_type": "number",
        "id": 1,
        "name": "Turkey Support Number",
        "number": "+908503902777"
    }
}
 

Request      

GET api/v20211124/numbers/{id}

URL Parameters

id  integer  

The ID of the Number.

Task

List all Tasks

requires authentication

This endpoint let you list tasks. You can use sort and filter feature at this endpoint.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/tasks" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://app.hipcall.com/api/v20211124/tasks"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/tasks',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 17
vary: Origin
 

{
    "data": [
        {
            "resource_type": "task",
            "id": 1,
            "name": "Error ut quis delectus omnis.",
            "description": "Eaque neque reprehenderit animi fugiat aut consequuntur. Rerum nobis iusto qui aperiam. In ad sint perspiciatis sit nihil.",
            "due_date": "2022-10-23T12:29:36+0000",
            "done": false,
            "done_at": null,
            "assign_to": null,
            "priority": "",
            "task_list_id": null,
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "task",
            "id": 2,
            "name": "In vel pariatur ut et sit facere corrupti ipsa.",
            "description": "Eum pariatur accusamus autem at. Voluptatem alias quia esse voluptates deleniti. Molestiae ipsum aut odio voluptate dolor.",
            "due_date": "2022-11-09T09:20:02+0000",
            "done": false,
            "done_at": null,
            "assign_to": null,
            "priority": "high",
            "task_list_id": null,
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "task",
            "id": 3,
            "name": "Reiciendis vitae ad reiciendis voluptate ab qui.",
            "description": "Soluta ea dicta architecto in doloremque rerum. Tempora aut autem quia placeat ipsam autem. Qui ex molestiae provident dolore ut alias alias.",
            "due_date": null,
            "done": false,
            "done_at": null,
            "assign_to": null,
            "priority": "",
            "task_list_id": null,
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "task",
            "id": 4,
            "name": "Possimus ut qui ad et.",
            "description": "Non non ut earum est. In perspiciatis assumenda minima quas et. Molestiae qui commodi nulla incidunt ea est.",
            "due_date": "2022-10-26T14:37:03+0000",
            "done": false,
            "done_at": null,
            "assign_to": null,
            "priority": "low",
            "task_list_id": null,
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "task",
            "id": 5,
            "name": "Excepturi ea excepturi quia vel sit magni vel.",
            "description": "Et architecto quos in odio. Voluptatem reiciendis recusandae quod animi iure sit quo non. Quos est libero aut.",
            "due_date": "2022-10-31T07:12:37+0000",
            "done": true,
            "done_at": "2003-09-13T06:29:59+0000",
            "assign_to": null,
            "priority": "medium",
            "task_list_id": null,
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "task",
            "id": 6,
            "name": "Saepe totam assumenda ratione.",
            "description": "Voluptatum aut deleniti officia voluptas. Itaque saepe laudantium nisi praesentium molestiae rerum. Quaerat et aut odit.",
            "due_date": null,
            "done": false,
            "done_at": null,
            "assign_to": null,
            "priority": "low",
            "task_list_id": null,
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "task",
            "id": 7,
            "name": "Alias dolorem et praesentium quis unde impedit.",
            "description": "Enim consequuntur assumenda dolor in. Illum maiores vero dolores maxime voluptatem minus in dolore. Assumenda repellat velit ut ea quod omnis.",
            "due_date": null,
            "done": false,
            "done_at": null,
            "assign_to": null,
            "priority": "medium",
            "task_list_id": null,
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "task",
            "id": 8,
            "name": "Dolorem vel quae commodi quia nobis commodi nemo.",
            "description": "Quaerat sunt modi minus vero nulla nihil. Quisquam dolor rem rerum aperiam ea qui.",
            "due_date": "2022-11-02T00:57:31+0000",
            "done": true,
            "done_at": "1998-08-16T21:47:37+0000",
            "assign_to": null,
            "priority": "",
            "task_list_id": null,
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "task",
            "id": 9,
            "name": "Quasi aut nemo dolor et.",
            "description": "In consequatur perspiciatis suscipit nesciunt temporibus. Tenetur dolorum sequi explicabo impedit ducimus omnis.",
            "due_date": null,
            "done": true,
            "done_at": "1987-12-11T04:44:18+0000",
            "assign_to": null,
            "priority": "low",
            "task_list_id": null,
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "task",
            "id": 10,
            "name": "Qui sequi at sint expedita et ex voluptas.",
            "description": "Perspiciatis modi id ea est velit perspiciatis. Voluptatibus ut cupiditate animi aperiam. Voluptatem ipsum iusto libero. Autem eum voluptatum sed.",
            "due_date": null,
            "done": false,
            "done_at": null,
            "assign_to": null,
            "priority": "",
            "task_list_id": null,
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        }
    ],
    "links": {
        "first": "https://app.hipcall.com/api/v20211124/tasks?page=1",
        "last": "https://app.hipcall.com/api/v20211124/tasks?page=3",
        "prev": null,
        "next": "https://app.hipcall.com/api/v20211124/tasks?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 3,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://app.hipcall.com/api/v20211124/tasks?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://app.hipcall.com/api/v20211124/tasks?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://app.hipcall.com/api/v20211124/tasks?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "https://app.hipcall.com/api/v20211124/tasks?page=2",
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://app.hipcall.com/api/v20211124/tasks",
        "per_page": 10,
        "to": 10,
        "total": 23
    }
}
 

Request      

GET api/v20211124/tasks

Body Parameters

q  string optional  

priority  string optional  

optional Filter by priority field. Supported params: low, medium, high. Example ?priority=high,medium.

assign_to  string optional  

optional Filter by assign_to field. Add users' ids. Example ?assign_to=1 or ?assign_to=1,4,5.

embed  string optional  

optional Embed resource to response. Embeddable resources: assign_to. Example ?embed=assign_to.

sort  string optional  

optional Field to sort by. Defaults to 'due_date'. Sortable fields: due_date. Example ?sort=due_date.

Retrieve a Task

requires authentication

Use this endpoint to retrieve a Task data.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/tasks/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.hipcall.com/api/v20211124/tasks/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/tasks/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 16
vary: Origin
 

{
    "data": {
        "resource_type": "task",
        "id": 1,
        "name": "Error ut quis delectus omnis.",
        "description": "Eaque neque reprehenderit animi fugiat aut consequuntur. Rerum nobis iusto qui aperiam. In ad sint perspiciatis sit nihil.",
        "due_date": "2022-10-23T12:29:36+0000",
        "done": false,
        "done_at": null,
        "assign_to": null,
        "priority": "",
        "task_list_id": null,
        "created_at": "2022-10-18T13:35:05+0000",
        "updated_at": "2022-10-18T13:35:05+0000"
    }
}
 

Request      

GET api/v20211124/tasks/{id}

URL Parameters

id  integer  

The ID of the Task.

Create a Task

requires authentication

Use this endpoint to create a Task data.

Example request:
curl --request POST \
    "https://app.hipcall.com/api/v20211124/tasks" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Sent an email to client\",
    \"description\": \"numquam\",
    \"due_date\": \"20220612 12:12:12\",
    \"assign_to\": 1,
    \"priority\": \"low\",
    \"task_list\": 19,
    \"contact_ids\": [
        1,
        2
    ],
    \"company_ids\": [
        1,
        2
    ],
    \"deal_ids\": [
        1,
        2
    ]
}"
const url = new URL(
    "https://app.hipcall.com/api/v20211124/tasks"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Sent an email to client",
    "description": "numquam",
    "due_date": "20220612 12:12:12",
    "assign_to": 1,
    "priority": "low",
    "task_list": 19,
    "contact_ids": [
        1,
        2
    ],
    "company_ids": [
        1,
        2
    ],
    "deal_ids": [
        1,
        2
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://app.hipcall.com/api/v20211124/tasks',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Sent an email to client',
            'description' => 'numquam',
            'due_date' => '20220612 12:12:12',
            'assign_to' => 1,
            'priority' => 'low',
            'task_list' => 19,
            'contact_ids' => [
                1,
                2,
            ],
            'company_ids' => [
                1,
                2,
            ],
            'deal_ids' => [
                1,
                2,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/v20211124/tasks

Body Parameters

name  string  

The name of the Task. min:2|max:255.

description  string optional  

The desciption of the Task. min:2|max:255 .

due_date  string optional  

The due date of the task. min:2.

assign_to  integer optional  

The user ID.

priority  string optional  

The priority of the task. Can be low, medium or high.

task_list  integer optional  

The ID of the Task list.

contact_ids  string[] optional  

The IDS of the related contacts.

company_ids  string[] optional  

The IDS of the related companies.

deal_ids  string[] optional  

The IDS of the related deals.

Team

List all Teams

requires authentication

This endpoint let you list teams. You can use search and filter feature at this endpoint.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/teams" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://app.hipcall.com/api/v20211124/teams"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/teams',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 19
vary: Origin
 

{
    "data": [
        {
            "resource_type": "team",
            "id": 1,
            "name": "Microsoft Team",
            "user_case": "all",
            "wrap_up_time": 15,
            "strategy": "random",
            "say_line_number": true,
            "say_line_number_in_second": 120,
            "callback": false,
            "callback_dtmf": 0,
            "callback_action": "none",
            "state": "active"
        }
    ],
    "links": {
        "first": "https://app.hipcall.com/api/v20211124/teams?page=1",
        "last": "https://app.hipcall.com/api/v20211124/teams?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://app.hipcall.com/api/v20211124/teams?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://app.hipcall.com/api/v20211124/teams",
        "per_page": 10,
        "to": 1,
        "total": 1
    }
}
 

Request      

GET api/v20211124/teams

Body Parameters

q  string optional  

optional Search at name. Example ?q=Sales.

status  string optional  

optional Filter by status field. Supported params: 1, active, 0, passive. Example ?status=active.

Retrieve a Team

requires authentication

Use this endpoint to retrieve a Team data.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/teams/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.hipcall.com/api/v20211124/teams/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/teams/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 18
vary: Origin
 

{
    "data": {
        "resource_type": "team",
        "id": 1,
        "name": "Microsoft Team",
        "user_case": "all",
        "wrap_up_time": 15,
        "strategy": "random",
        "say_line_number": true,
        "say_line_number_in_second": 120,
        "callback": false,
        "callback_dtmf": 0,
        "callback_action": "none",
        "state": "active"
    }
}
 

Request      

GET api/v20211124/teams/{id}

URL Parameters

id  integer  

The ID of the Team.

User

List all Users

requires authentication

This endpoint let you list users. You can use search and filter feature at this endpoint.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://app.hipcall.com/api/v20211124/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/users',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 27
vary: Origin
 

{
    "data": [
        {
            "resource_type": "user",
            "id": 1,
            "email": "bill@microsoft.com",
            "name": "Bill Gates",
            "full_name": "Bill Gates",
            "title": "",
            "owner": true,
            "locale": "en",
            "status": "active",
            "default_number_id": 1,
            "default_extension_id": 1,
            "2fa": false,
            "last_logged_in": "2022-11-03T08:09:59+0000",
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-11-03T08:09:59+0000"
        },
        {
            "resource_type": "user",
            "id": 2,
            "email": "satya@microsoft.com",
            "name": "Satya Nadella",
            "full_name": "Satya Nadella",
            "title": "",
            "owner": false,
            "locale": "en",
            "status": "active",
            "default_number_id": 1,
            "default_extension_id": 2,
            "2fa": false,
            "last_logged_in": null,
            "created_at": "2022-10-18T13:35:05+0000",
            "updated_at": "2022-10-18T13:35:05+0000"
        },
        {
            "resource_type": "user",
            "id": 3,
            "email": "cmraz@example.com",
            "name": "Ismael Ankunding",
            "full_name": "Ismael Ankunding",
            "title": "Coroner",
            "owner": false,
            "locale": "en",
            "status": "active",
            "default_number_id": null,
            "default_extension_id": null,
            "2fa": false,
            "last_logged_in": "2010-03-14T07:53:22+0000",
            "created_at": "2022-10-18T13:35:07+0000",
            "updated_at": "2022-10-18T13:35:07+0000"
        },
        {
            "resource_type": "user",
            "id": 4,
            "email": "cummings.norberto@example.org",
            "name": "Jenifer Dietrich",
            "full_name": "Jenifer Dietrich",
            "title": "Boiler Operator",
            "owner": false,
            "locale": "en",
            "status": "active",
            "default_number_id": null,
            "default_extension_id": null,
            "2fa": false,
            "last_logged_in": null,
            "created_at": "2022-10-18T13:35:07+0000",
            "updated_at": "2022-10-18T13:35:07+0000"
        },
        {
            "resource_type": "user",
            "id": 5,
            "email": "keshawn.hill@example.net",
            "name": "Autumn Beer",
            "full_name": "Autumn Beer",
            "title": "Fashion Designer",
            "owner": false,
            "locale": "en",
            "status": "active",
            "default_number_id": null,
            "default_extension_id": null,
            "2fa": false,
            "last_logged_in": "1985-12-20T03:42:06+0000",
            "created_at": "2022-10-18T13:35:07+0000",
            "updated_at": "2022-10-18T13:35:07+0000"
        },
        {
            "resource_type": "user",
            "id": 6,
            "email": "braun.trudie@example.org",
            "name": "Melvina Lindgren",
            "full_name": "Melvina Lindgren",
            "title": "Market Research Analyst",
            "owner": false,
            "locale": "en",
            "status": "active",
            "default_number_id": null,
            "default_extension_id": null,
            "2fa": false,
            "last_logged_in": null,
            "created_at": "2022-10-18T13:35:07+0000",
            "updated_at": "2022-10-18T13:35:07+0000"
        },
        {
            "resource_type": "user",
            "id": 7,
            "email": "mossie.deckow@example.net",
            "name": "Imogene Tillman",
            "full_name": "Imogene Tillman",
            "title": "Pesticide Sprayer",
            "owner": false,
            "locale": "en",
            "status": "active",
            "default_number_id": null,
            "default_extension_id": null,
            "2fa": false,
            "last_logged_in": null,
            "created_at": "2022-10-18T13:35:07+0000",
            "updated_at": "2022-10-18T13:35:07+0000"
        },
        {
            "resource_type": "user",
            "id": 8,
            "email": "akulas@example.com",
            "name": "Joan Klein",
            "full_name": "Joan Klein",
            "title": "Metal-Refining Furnace Operator",
            "owner": false,
            "locale": "en",
            "status": "active",
            "default_number_id": null,
            "default_extension_id": null,
            "2fa": false,
            "last_logged_in": null,
            "created_at": "2022-10-18T13:35:07+0000",
            "updated_at": "2022-10-18T13:35:07+0000"
        },
        {
            "resource_type": "user",
            "id": 9,
            "email": "germaine.goldner@example.org",
            "name": "Alverta Gutmann",
            "full_name": "Alverta Gutmann",
            "title": "Food Tobacco Roasting",
            "owner": false,
            "locale": "en",
            "status": "active",
            "default_number_id": null,
            "default_extension_id": null,
            "2fa": false,
            "last_logged_in": "1979-10-19T02:31:47+0000",
            "created_at": "2022-10-18T13:35:07+0000",
            "updated_at": "2022-10-18T13:35:07+0000"
        },
        {
            "resource_type": "user",
            "id": 10,
            "email": "vaufderhar@example.net",
            "name": "Javon Schmitt",
            "full_name": "Javon Schmitt",
            "title": "Educational Psychologist",
            "owner": false,
            "locale": "en",
            "status": "active",
            "default_number_id": null,
            "default_extension_id": null,
            "2fa": false,
            "last_logged_in": null,
            "created_at": "2022-10-18T13:35:07+0000",
            "updated_at": "2022-10-18T13:35:07+0000"
        }
    ],
    "links": {
        "first": "https://app.hipcall.com/api/v20211124/users?page=1",
        "last": "https://app.hipcall.com/api/v20211124/users?page=3",
        "prev": null,
        "next": "https://app.hipcall.com/api/v20211124/users?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 3,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://app.hipcall.com/api/v20211124/users?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://app.hipcall.com/api/v20211124/users?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://app.hipcall.com/api/v20211124/users?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "https://app.hipcall.com/api/v20211124/users?page=2",
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://app.hipcall.com/api/v20211124/users",
        "per_page": 10,
        "to": 10,
        "total": 28
    }
}
 

Request      

GET api/v20211124/users

Body Parameters

q  string optional  

optional Search at first_name, last_name and email. Example ?q=Bill.

status  string optional  

optional Filter by status field. Supported params: 1, active, 0, passive. Example ?status=active.

Retrieve a User

requires authentication

Use this endpoint to retrieve a User data.

Example request:
curl --request GET \
    --get "https://app.hipcall.com/api/v20211124/users/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.hipcall.com/api/v20211124/users/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://app.hipcall.com/api/v20211124/users/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 26
vary: Origin
 

{
    "data": {
        "resource_type": "user",
        "id": 2,
        "email": "satya@microsoft.com",
        "name": "Satya Nadella",
        "title": "",
        "owner": false,
        "locale": "en",
        "default_number_id": 1,
        "default_extension_id": 2,
        "2fa": false,
        "last_logged_in": null,
        "created_at": "2022-10-18T13:35:05+0000",
        "updated_at": "2022-10-18T13:35:05+0000"
    }
}
 

Request      

GET api/v20211124/users/{id}

URL Parameters

id  integer  

The ID of the User.

Update an exist User

requires authentication

Use this endpoint to update an exist User's default number

Example request:
curl --request PUT \
    "https://app.hipcall.com/api/v20211124/users/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://app.hipcall.com/api/v20211124/users/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://app.hipcall.com/api/v20211124/users/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

PUT api/v20211124/users/{id}

URL Parameters

id  integer  

The ID of the user.

default_number_id  integer  

The ID of an active number.

Body Parameters

default_number_id  string optional