whilesmart / eloquent-contacts
Polymorphic contacts (people attached to customers, vendors, anything) for Laravel applications.
Requires
- php: ^8.2
- laravel/framework: ^11.0|^12.0
- whilesmart/eloquent-owner-access: dev-dev
Requires (Dev)
- fakerphp/faker: ^1.24
- laravel/pint: ^1.22
- orchestra/testbench: ^9.0|^10.0
This package is auto-updated.
Last update: 2026-06-10 18:02:08 UTC
README
Polymorphic contacts for Laravel: people (with name, email, phone, title) attached to any
model, scoped to an owner through
whilesmart/eloquent-owner-access.
An org customer with several people, a vendor with an AP desk, anything with humans behind it.
Install
composer require whilesmart/eloquent-contacts
php artisan migrate
Routes register automatically under the api prefix with auth:sanctum. Set
CONTACTS_REGISTER_ROUTES=false to mount them yourself.
Attaching contacts to a model
use Whilesmart\Contacts\Traits\HasContacts; class Customer extends Model { use HasContacts; } $customer->contacts()->create([ 'owner_type' => Workspace::class, 'owner_id' => $workspaceId, 'first_name' => 'Jane', 'last_name' => 'Doe', 'email' => 'ap@acme.test', 'title' => 'Accounts Payable', 'address' => '12 Market St, Douala', 'is_primary' => true, ]); $customer->primaryContact?->email; // recipient for billing $customer->primaryContact?->full_name; // "Jane Doe"
contacts() returns every contact; primaryContact() returns the one flagged primary. Only
one contact per parent can be primary: setting is_primary on one demotes the others
automatically.
Custom model
The Contact model is swappable. Publish the config and point contacts.model at your own
class (extend the package model to add fields/casts/behaviour):
// config/contacts.php 'model' => \App\Models\Contact::class,
The trait relations, route binding, and controller all resolve the class from config, so your model is used everywhere.
UUID keys
Off by default (auto-incrementing integer ids). To use UUID primary keys, set CONTACTS_UUIDS=true
(or contacts.uuids config) before running the migration. The migration then creates a
uuid primary key and uuid morph columns, and the model generates an ordered UUID on create.
This assumes the owner and contactable models also use UUID keys.
Endpoints
| Method | Path | Purpose |
|---|---|---|
| GET | /api/contacts |
List (filter by owner_*, contactable_type + contactable_id, q) |
| POST | /api/contacts |
Create |
| GET | /api/contacts/{contact} |
Show |
| PUT/PATCH | /api/contacts/{contact} |
Update |
| DELETE | /api/contacts/{contact} |
Soft delete |
List a single parent's people with
/api/contacts?contactable_type=App\Models\Customer&contactable_id=42.