---
title: "API Get Caller"
slug: "api-get-caller"
tags: ["BookingTimes API"]
updated: 2025-10-08T04:54:11Z
published: 2025-10-08T04:54:11Z
canonical: "support.bookingtimes.com/api-get-caller"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.bookingtimes.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Get Caller

## Get Caller API

To enable this API Key follow the steps denoted on this article first [Enable API](/v2/docs/enable-api).

### Overview

The Get Caller API allows you to connect your phone system to load the caller’s name from the database, allowing you to know who’s calling before you pickup the phone.

### Base URL

```plaintext
https://examplebusiness.com/Api/v1/GetCaller
```

### Endpoint

- **HTTP Method**: `GET`
- **Endpoint**: `/Api/v1/GetCaller`

### Authentication

This API requires an API key, which should be provided in the `x-api-key` header.

### Request Headers

| Header | Type | Required | Description |
| --- | --- | --- | --- |
| `Cache-Control` | String | Yes | Set to `no-cache`. |
| `Content-Type` | String | Yes | Must be `application/json`. |
| `Accept` | String | Yes | Expected response format (JSON). |
| `x-api-key` | String | Yes | API key provided for authorization. |

### Request Parameters

The following parameters should be passed in the request:

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `Phone` | String | Yes | The phone number of the caller. |

- **Parameter Location**: Query String (e.g., `?Phone=0730628336`).

### Example Request

**Request URL with** `ReferenceNbr` **and** `JobNbr`**:**

```vbscript-html
POST https://examplebusiness.com/Api/v1/GetCaller?Phone=0730628336
```

- *Search Behavior:* The system will look for a client with the phone number `0730628336`

**Headers**:

```vbnet
codeCache-Control: no-cache
Content-Type: application/json
Accept: application/json
x-api-key: {your_api_key}
```

### Response

The API returns a `RestResponse` object containing the client’s name in the result.

#### Success Response

| Status Code | Description |
| --- | --- |
| `200 OK` | Confirmation successful. |

#### Error Responses

If an error occurs, the response will include an appropriate HTTP status code and error details.

| Status Code | Description |
| --- | --- |
| `400 Bad Request` | The request is missing required parameters. |
| `401 Unauthorized` | The provided API key is missing or invalid. |
| `403 Forbidden` | The client does not have permission to access this endpoint. |
| `405 Method Not Allowed` | The HTTP method used is not allowed; only `POST` is accepted. |
| `406 Not Acceptable` | The server cannot produce a response matching the acceptable values. |
| `500 Internal Server Error` | An error occurred on the server side. |

### Example Code

Here’s an example of how to call the API in .NET:

```vbnet
Imports RestSharp

Dim rest As New RestClient("https://examplebusiness.com")
Dim request = New RestRequest("Api/v1/GetCaller?Phone=" &"0730628336", Method.GET)

request.RequestFormat = DataFormat.Json
request.AddHeader("Cache-Control", "no-cache")
request.AddHeader("Content-Type", "application/json")
request.AddHeader("Accept", "application/json")
request.AddHeader("x-api-key", "{your_api_key}")

Dim response = rest.Execute(request)

If response.StatusCode = HttpStatusCode.OK Then
    Console.WriteLine(response.Content)
Else
    Console.WriteLine("Error: " & response.StatusDescription)
End If
```

### Notes

- Ensure that you replace `{examplebusiness.com}` with your actual business website URL.
- Ensure that you replace `{your_api_key}` with the latest you have from the **Enabling Access** step.

### Contact and Support

For additional assistance or to report issues with the API, please contact support@bookingtimes.com or visit our [Support Page](https://support.bookingtimes.com/).