Contacts

Base URL: /api/v1/contacts

Auth required: Yes (auth:api) for all endpoints.

Contacts are polymorphic: they belong to either a Customer or a Prospect (the contactable).

Model Properties

Read-only computed fields (returned in GET /v1/contacts/{id}):

GET /v1/contacts

List contacts for a specific entity (customer or prospect). Results are ordered by last_name, first_name.

Query parameters:

Response 200: Array of contact objects.

Examples:

curl -s -X GET "https://your-instance.bluerocktel.net/api/v1/contacts?contactable_type=App%5CCustomer&contactable_id=10" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

import requests

response = requests.get(
    "https://your-instance.bluerocktel.net/api/v1/contacts",
    params={"contactable_type": "App\\Customer", "contactable_id": 10},
    headers={"Authorization": f"Bearer {token}", "Accept": "application/json"},
)
contacts = response.json()

use Illuminate\Support\Facades\Http;

$response = Http::withToken($token)
    ->acceptJson()
    ->get('https://your-instance.bluerocktel.net/api/v1/contacts', [
        'contactable_type' => 'App\\Customer',
        'contactable_id' => 10,
    ]);

$contacts = $response->json();

const response = await fetch(
  "https://your-instance.bluerocktel.net/api/v1/contacts?contactable_type=App%5CCustomer&contactable_id=10",
  {
    headers: {
      Authorization: `Bearer ${token}`,
      Accept: "application/json",
    },
  }
);
const contacts = await response.json();

POST /v1/contacts

Create a new contact for an entity. Sets sync_needed = true and triggers reindexing of the contactable.

Query parameters:

Body (JSON): Validated via contact model attributes.

Response 201: Created contact object. Response 422: Validation error.

Examples:

curl -s -X POST "https://your-instance.bluerocktel.net/api/v1/contacts?contactable_type=App%5CCustomer&contactable_id=10" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"first_name": "Jane", "last_name": "Doe", "email": "jane.doe@example.com"}'

import requests

response = requests.post(
    "https://your-instance.bluerocktel.net/api/v1/contacts",
    params={"contactable_type": "App\\Customer", "contactable_id": 10},
    json={"first_name": "Jane", "last_name": "Doe", "email": "jane.doe@example.com"},
    headers={"Authorization": f"Bearer {token}", "Accept": "application/json"},
)
contact = response.json()

$response = Http::withToken($token)
    ->acceptJson()
    ->post('https://your-instance.bluerocktel.net/api/v1/contacts?contactable_type=App%5CCustomer&contactable_id=10', [
        'first_name' => 'Jane',
        'last_name' => 'Doe',
        'email' => 'jane.doe@example.com',
    ]);

$contact = $response->json();

const response = await fetch(
  "https://your-instance.bluerocktel.net/api/v1/contacts?contactable_type=App%5CCustomer&contactable_id=10",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      Accept: "application/json",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      first_name: "Jane",
      last_name: "Doe",
      email: "jane.doe@example.com",
    }),
  }
);
const contact = await response.json();

GET /v1/contacts/{id}

Get a single contact with company info, customer_account, client permissions, and contactable metadata.

URL parameters:

Response 200: Contact object with permissions. Response 404: Not found.

PUT /v1/contacts/{id}

Update a contact. If a client account is linked, permissions are synced. Triggers contactable reindexing.

URL parameters:

Body (JSON): Validated contact fields.

Response 201: Updated contact object. Response 404: Not found. Response 422: Validation error.

DELETE /v1/contacts/{id}

Delete a contact.

URL parameters:

Response 200: Success message. Response 404: Not found.

GET /v1/contacts/numbers

Find a contact by phone number. Used by 3CX call flow integrations.

Query parameters:

Response 200:

{
  "data": { ...contact object... }
}

Response 404: Not found.

Examples:

curl -s -X GET "https://your-instance.bluerocktel.net/api/v1/contacts/numbers?phoneNumber=%2B33612345678" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

import requests

response = requests.get(
    "https://your-instance.bluerocktel.net/api/v1/contacts/numbers",
    params={"phone_number": "+33612345678"},
    headers={"Authorization": f"Bearer {token}", "Accept": "application/json"},
)
contact = response.json()

$response = Http::withToken($token)
    ->acceptJson()
    ->get('https://your-instance.bluerocktel.net/api/v1/contacts/numbers', [
        'phone_number' => '+33612345678',
    ]);

$contact = $response->json();

const response = await fetch(
  "https://your-instance.bluerocktel.net/api/v1/contacts/numbers?phoneNumber=%2B33612345678",
  {
    headers: {
      Authorization: `Bearer ${token}`,
      Accept: "application/json",
    },
  }
);
const contact = await response.json();

GET /v1/contacts/{id}/accounts

Find all accounts (customers or prospects) sharing the same email address as this contact.

URL parameters:

Response 200: Array of account objects.

GET /v1/contacts/{id}/coworkers

Get all contacts at the same organization as the given contact (same company/domain).

URL parameters:

Response 200: Array of contact objects.