Tenants API — Full CRUD Reference for Tenant Accounts

Tenants are the top-level organisational unit in LaraCopilot. Every extension, DID number, call queue, rate plan, and call detail record belongs to exactly one tenant. The tenant’s slug and domain must be globally unique across the platform. All endpoints require an active admin session — include the session cookie obtained from POST /api/admin/login with every request. The list endpoint supports an optional search query parameter that filters across name, slug, and domain. List responses include computed counts for extensions_count, dids_count, and queues_count. The show endpoint additionally eager-loads the full extensions, dids, queues, and rates relations.

GET /api/tenants

Returns all tenants ordered by creation date descending, with relation counts attached. Query parameters

string

Optional. Filters tenants whose name, slug, or domain contains the given string (case-insensitive).

string

Value is "Tenants fetched successfully.".

array

Array of tenant objects.

Show tenant object fields

integer

Auto-incremented primary key.

string

Human-readable tenant name.

string

URL-safe unique identifier for the tenant.

string

Fully-qualified domain name associated with this tenant.

string

Current lifecycle status of the tenant, e.g. active or suspended.

string

IANA timezone string, e.g. America/New_York.

integer

Maximum number of extensions this tenant may provision.

object|null

Arbitrary key-value configuration bag for tenant-level settings.

integer

Number of extensions currently assigned to this tenant.

integer

Number of DID numbers currently assigned to this tenant.

integer

Number of call queues currently assigned to this tenant.

string

ISO 8601 creation timestamp.

string

ISO 8601 last-updated timestamp.

curl https://your-instance.laracopilot.com/api/tenants \
  -H "Accept: application/json" \
  -b cookies.txt

curl "https://your-instance.laracopilot.com/api/tenants?search=acme" \
  -H "Accept: application/json" \
  -b cookies.txt

{
  "message": "Tenants fetched successfully.",
  "data": [
    {
      "id": 1,
      "name": "Acme Corp",
      "slug": "acme-corp",
      "domain": "acme.laracopilot.com",
      "status": "active",
      "timezone": "America/New_York",
      "max_extensions": 50,
      "settings": { "record_calls": true },
      "extensions_count": 12,
      "dids_count": 4,
      "queues_count": 2,
      "created_at": "2025-01-15T09:00:00.000000Z",
      "updated_at": "2025-03-20T14:30:00.000000Z"
    }
  ]
}

POST /api/tenants

Creates a new tenant. Returns 201 Created with the new tenant record on success.

string

required

Human-readable name for the tenant. Maximum 255 characters.

string

required

URL-safe unique identifier. Must be unique across all tenants. Maximum 255 characters.

string

required

Fully-qualified domain name for the tenant. Must be unique across all tenants. Maximum 255 characters.

string

required

Lifecycle status, e.g. active, suspended. Maximum 50 characters.

string

required

IANA timezone identifier, e.g. America/Chicago. Maximum 100 characters.

integer

required

Maximum number of extensions the tenant can provision. Minimum value: 1.

object

Optional. Arbitrary JSON object for tenant-level configuration. Stored as-is.

string

Value is "Tenant created successfully.".

object

The newly created tenant record. Contains the same fields as described in the list response above, without relation counts.

curl -X POST https://your-instance.laracopilot.com/api/tenants \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -b cookies.txt \
  -d '{
    "name": "Globex Telecom",
    "slug": "globex-telecom",
    "domain": "globex.laracopilot.com",
    "status": "active",
    "timezone": "America/Chicago",
    "max_extensions": 100,
    "settings": { "record_calls": false }
  }'

{
  "message": "Tenant created successfully.",
  "data": {
    "id": 2,
    "name": "Globex Telecom",
    "slug": "globex-telecom",
    "domain": "globex.laracopilot.com",
    "status": "active",
    "timezone": "America/Chicago",
    "max_extensions": 100,
    "settings": { "record_calls": false },
    "created_at": "2025-04-22T10:00:00.000000Z",
    "updated_at": "2025-04-22T10:00:00.000000Z"
  }
}

GET /api/tenants/

Fetches a single tenant by its ID. The response eager-loads the full extensions, dids, queues, and rates relations. Path parameters

integer

required

The numeric ID of the tenant to retrieve.

string

Value is "Tenant loaded successfully.".

object

The tenant record with extensions, dids, queues, and rates arrays included.

curl https://your-instance.laracopilot.com/api/tenants/2 \
  -H "Accept: application/json" \
  -b cookies.txt

{
  "message": "Tenant loaded successfully.",
  "data": {
    "id": 2,
    "name": "Globex Telecom",
    "slug": "globex-telecom",
    "domain": "globex.laracopilot.com",
    "status": "active",
    "timezone": "America/Chicago",
    "max_extensions": 100,
    "settings": { "record_calls": false },
    "extensions": [],
    "dids": [],
    "queues": [],
    "rates": [],
    "created_at": "2025-04-22T10:00:00.000000Z",
    "updated_at": "2025-04-22T10:00:00.000000Z"
  }
}

PUT /api/tenants/

Replaces all fields on an existing tenant. Accepts the same body as POST /api/tenants. PATCH /api/tenants/{tenant} is also accepted and uses the same handler. Path parameters

integer

required

The numeric ID of the tenant to update.

string

required

Human-readable name. Maximum 255 characters.

string

required

Must be unique across all tenants, excluding the current record. Maximum 255 characters.

string

required

Must be unique across all tenants, excluding the current record. Maximum 255 characters.

string

required

Lifecycle status. Maximum 50 characters.

string

required

IANA timezone identifier. Maximum 100 characters.

integer

required

Minimum value: 1.

object

Optional. Replaces the existing settings object entirely.

string

Value is "Tenant updated successfully.".

object

The updated tenant record.

curl -X PUT https://your-instance.laracopilot.com/api/tenants/2 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -b cookies.txt \
  -d '{
    "name": "Globex Telecom",
    "slug": "globex-telecom",
    "domain": "globex.laracopilot.com",
    "status": "suspended",
    "timezone": "America/Chicago",
    "max_extensions": 100,
    "settings": { "record_calls": false }
  }'

{
  "message": "Tenant updated successfully.",
  "data": {
    "id": 2,
    "name": "Globex Telecom",
    "slug": "globex-telecom",
    "domain": "globex.laracopilot.com",
    "status": "suspended",
    "timezone": "America/Chicago",
    "max_extensions": 100,
    "settings": { "record_calls": false },
    "created_at": "2025-04-22T10:00:00.000000Z",
    "updated_at": "2025-04-22T11:00:00.000000Z"
  }
}

DELETE /api/tenants/

Permanently deletes the specified tenant. This action cannot be undone. Path parameters

integer

required

The numeric ID of the tenant to delete.

string

Value is "Tenant deleted successfully.".

curl -X DELETE https://your-instance.laracopilot.com/api/tenants/2 \
  -H "Accept: application/json" \
  -b cookies.txt

{
  "message": "Tenant deleted successfully."
}

Authentication

Resources

Messaging

Tenants API — Full CRUD Reference for Tenant Accounts

GET /api/tenants

POST /api/tenants

GET /api/tenants/

PUT /api/tenants/

DELETE /api/tenants/

​GET /api/tenants

​POST /api/tenants

​GET /api/tenants/

​PUT /api/tenants/

​DELETE /api/tenants/

GET /api/tenants

POST /api/tenants

GET /api/tenants/

PUT /api/tenants/

DELETE /api/tenants/