Krayin CRM

https://github.com/krayin/laravel-crm
Admin
Krayin CRM is a free and open-source Laravel-based CRM solution designed for SMEs and Enterprises to...
Tokens:255,983
Snippets:1,968
Trust Score:9.4
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### GET /install

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Initiates the installation process. This endpoint is public and returns the installer interface.

```APIDOC
## GET /install

### Description
Initiates the installation process. This endpoint is public and returns the installer interface.

### Method
GET

### Endpoint
`/install`

### Response
#### Success Response (200)
Returns the installer page.

```

--------------------------------

### Install Krayin CRM via artisan command

Source: https://github.com/krayin/laravel-crm/blob/2.2/README.md

Run this command after configuring the .env file to install Krayin CRM. It sets up the database and other required components.

```bash
php artisan krayin-crm:install
```

--------------------------------

### Usage example for menu() facade

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/core.md

Shows how to retrieve permission-filtered admin menu items, get a display label with a fallback translation key, and echo the URL of the currently active admin menu item.

```php
$items = menu()->getItems(Menu::ADMIN);          // permission-filtered admin menu
$label = menu()->getLabel('leads', 'admin::app.layouts.leads');
if ($item = menu()->getCurrentActiveMenu(Menu::ADMIN)) {
    echo $item->getUrl();
}
```

--------------------------------

### Run krayin-crm:install CLI command

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/installer.md

Interactive CLI command that runs server requirements, env, DB, and seeder steps without the browser. Alternative: visit https://your-crm.test/install.

```bash
php artisan krayin-crm:install
# or visit https://your-crm.test/install
```

--------------------------------

### POST /install/api/env-file-setup

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Sets up the environment file during installation. This endpoint is public but returns 403 once installation is complete.

```APIDOC
## POST /install/api/env-file-setup

### Description
Sets up the environment file during installation. This endpoint is public but returns 403 once installation is complete.

### Method
POST

### Endpoint
`/install/api/env-file-setup`

### Response
#### Success Response (200)
Returns a success message.

#### Forbidden (403)
Returns 403 if installation is already complete.

```

--------------------------------

### Using vite() helper to resolve and set assets

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/core.md

Example usage of the vite() helper. Calls asset() to get a URL for 'css/admin.css' and set() to register a JavaScript entry point, both under the 'admin' namespace.

```php
$url = vite()->asset('css/admin.css', 'admin');
vite()->set(['src/Resources/assets/js/app.js'], 'admin');
```

--------------------------------

### POST /install/api/admin-config-setup

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Sets up the admin configuration during installation. This endpoint is public but returns 403 once installation is complete.

```APIDOC
## POST /install/api/admin-config-setup

### Description
Sets up the admin configuration during installation. This endpoint is public but returns 403 once installation is complete.

### Method
POST

### Endpoint
`/install/api/admin-config-setup`

### Response
#### Success Response (200)
Returns a success message.

#### Forbidden (403)
Returns 403 if installation is already complete.

```

--------------------------------

### Import usage example

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/data-transfer.md

Shows how to create an import record and run validation. The import record specifies type, action, validation strategy, allowed errors, and file path. After validate(), call start(), link(), and index() in sequence.

```php
use Webkul\DataTransfer\Helpers\Import;
use Webkul\DataTransfer\Repositories\ImportRepository;

$importRecord = app(ImportRepository::class)->create([
    'type' => 'leads',
    'action' => 'append',
    'validation_strategy' => Import::VALIDATION_STRATEGY_SKIP_ERRORS,
    'allowed_errors' => 100,
    'file_path' => storage_path('app/uploads/import.csv'),
]);

app(Import::class)
    ->setImport($importRecord)
    ->validate();   // then start(), link(), index() in sequence
```

--------------------------------

### Krayin Vite configuration for admin, installer, and webform

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/configuration.md

Configures Vite hot files, build directories, and package assets directories for the admin, installer, and webform entry points. A missing namespace results in a ViterNotFound error.

```php
'viters' => [
    'admin'     => ['hot_file' => 'admin-vite.hot', 'build_directory' => 'admin/build', 'package_assets_directory' => 'src/Resources/assets'],
    'installer' => ['hot_file' => 'installer-vite.hot', 'build_directory' => 'installer/build', 'package_assets_directory' => 'src/Resources/assets'],
    'webform'   => ['hot_file' => 'webform-vite.hot', 'build_directory' => 'webform/build', 'package_assets_directory' => 'src/Resources/assets'],
],
```

--------------------------------

### Usage example for ACL methods

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/core.md

Shows how to use acl() to get all items, get roles mapping, and iterate over authorized items. The getRoles() returns a route-name to permission-key map, and getAuthorizedItems() returns items the acting user may grant.

```php
$all = acl()->getItems();
$roles = acl()->getRoles();                    // e.g. ['admin.leads.index' => 'leads']
foreach (acl()->getAuthorizedItems() as $item) {
    echo $item->key;                           // e.g. 'leads', 'settings.other_settings.web_forms'
}
```

--------------------------------

### InstallerController class with constants and constructor

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/installer.md

Defines the installer controller with minimum PHP version 8.1.0 and user ID 1. Injects server requirements, environment manager, and database manager via constructor property promotion.

```php
class InstallerController extends Controller
{
    const MIN_PHP_VERSION = '8.1.0';
    const USER_ID = 1;

    public function __construct(
        protected ServerRequirements $serverRequirements,
        protected EnvironmentManager $environmentManager,
        protected DatabaseManager $databaseManager
    ) {}
}
```

--------------------------------

### POST /install/api/run-migration

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Runs database migrations during installation. This endpoint is public but returns 403 once installation is complete.

```APIDOC
## POST /install/api/run-migration

### Description
Runs database migrations during installation. This endpoint is public but returns 403 once installation is complete.

### Method
POST

### Endpoint
`/install/api/run-migration`

### Response
#### Success Response (200)
Returns a success message.

#### Forbidden (403)
Returns 403 if installation is already complete.

```

--------------------------------

### POST /install/api/run-seeder

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Runs database seeders during installation. This endpoint is public but returns 403 once installation is complete.

```APIDOC
## POST /install/api/run-seeder

### Description
Runs database seeders during installation. This endpoint is public but returns 403 once installation is complete.

### Method
POST

### Endpoint
`/install/api/run-seeder`

### Response
#### Success Response (200)
Returns a success message.

#### Forbidden (403)
Returns 403 if installation is already complete.

```

--------------------------------

### Usage example for LeadRepository and PipelineRepository

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/lead.md

Shows how to instantiate LeadRepository and PipelineRepository via the app container, create a lead with person and products, perform a stage-only update, and retrieve the default pipeline.

```php
use Webkul\Lead\Repositories\LeadRepository;
use Webkul\Lead\Repositories\PipelineRepository;

$leads = app(LeadRepository::class);

$lead = $leads->create([
    'title' => 'Big deal',
    'lead_value' => 10000,
    'person' => ['name' => 'Jane', 'emails' => [['value' => 'jane@acme.test', 'label' => 'work']]],
    'products' => [['product_id' => 1, 'price' => 100, 'quantity' => 2]],
]);

$leads->update(['lead_pipeline_stage_id' => 3], $lead->id); // stage-only update keeps attributes

$pipeline = app(PipelineRepository::class)->getDefaultPipeline();
```

--------------------------------

### Usage example for system_config()

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/core.md

Demonstrates retrieving a config field definition, a stored config value, and the active configuration item using the system_config() helper.

```php
$field = system_config()->getConfigField('general.general.locale_settings.locale');
$value = system_config()->getConfigData('general.settings.menu_color');
$active = system_config()->getActiveConfigurationItem();
```

--------------------------------

### Usage example with LeadRepository

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/core-eloquent.md

Shows how to instantiate a repository via the app container and call findOrFail and count methods. The count method accepts an optional where array.

```php
use Webkul\Lead\Repositories\LeadRepository;

$leads = app(LeadRepository::class);

$lead = $leads->findOrFail(42);
$count = $leads->count(['user_id' => auth()->guard('user')->id()]);
```

--------------------------------

### Admin login credentials for Krayin CRM

Source: https://github.com/krayin/laravel-crm/blob/2.2/README.md

Default admin credentials to log in at http(s)://example.com/admin/login. Use these after installation to access the admin panel.

```text
email:admin@example.com
password:admin123
```

--------------------------------

### Create Krayin CRM project with Composer

Source: https://github.com/krayin/laravel-crm/blob/2.2/README.md

Run this command to create a new Krayin CRM project. It is the first step in the installation process, executed before configuring the .env file.

```bash
composer create-project
```

--------------------------------

### Development Cycle Commands

Source: https://github.com/krayin/laravel-crm/blob/2.2/AGENTS.md

Commands for installing dependencies, running migrations, executing the Pest test suite, and formatting code with Laravel Pint. Run ./vendor/bin/pint before committing as CI applies Pint formatting.

```bash
composer install            # install PHP dependencies
php artisan migrate          # run migrations
php artisan test --compact   # run the Pest test suite
./vendor/bin/pint            # format code (PSR-12 via Laravel Pint)
```

--------------------------------

### GET /help

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Displays the help page.

```APIDOC
## GET /help

### Description
Displays the help page.

### Method
GET

### Endpoint
/help

```

--------------------------------

### Run Krayin CRM locally with artisan serve

Source: https://github.com/krayin/laravel-crm/blob/2.2/README.md

Use these commands on a local development environment to clear the route cache and start the development server. Run them in order.

```bash
php artisan route:clear
php artisan serve
```

--------------------------------

### GET /activities

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

List all activities.

```APIDOC
## GET /activities

### Description
List all activities.

### Method
GET

### Endpoint
`/activities`

### Parameters
#### Query Parameters
- None specified

### Request Example
```
GET /activities
```

### Response
#### Success Response (200)
- None specified

#### Response Example
```json
{}
```
```

--------------------------------

### Repository usage for creating product and inventory

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/product.md

Shows how to use ProductRepository and ProductInventoryRepository to create a product and its inventory record. The example creates a product with name, sku, and price, then adds inventory with warehouse and location references, and finally outputs the computed on_hand value (45).

```php
use Webkul\Product\Repositories\ProductRepository;
use Webkul\Product\Repositories\ProductInventoryRepository;

$products = app(ProductRepository::class);

$product = $products->create([
    'name' => 'CRM Pro License',
    'sku' => 'CRM-PRO-1Y',
    'price' => 499,
]);

app(ProductInventoryRepository::class)->create([
    'product_id' => $product->id,
    'warehouse_id' => 1,
    'warehouse_location_id' => 2,
    'in_stock' => 50,
    'allocated' => 5,
]);

echo $product->inventories->first()->on_hand; // 45
```

--------------------------------

### Install production dependencies without dev packages

Source: https://github.com/krayin/laravel-crm/blob/2.2/README.md

Run this command on the server before going into production mode to uninstall developer dependencies. It is recommended to avoid exposing development tools.

```bash
composer install --no-dev
```

--------------------------------

### Core::version()

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/core.md

Returns the installed Krayin CRM version as a string. This is a static method on the Core class.

```APIDOC
## Core::version()

### Description
Returns the installed Krayin CRM version (`static::KRAYIN_VERSION`).

### Method
`version(): string`

### Returns
- **string** - The version string, e.g., '2.2.7'.

### Example
```php
$version = Core::version(); // '2.2.7'
```
```

--------------------------------

### PersonRepository usage example

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/contact.md

Demonstrates creating, updating, and finding a person using PersonRepository. The create method sanitizes data and fetches-or-creates an organization from organization_name.

```php
use Webkul\Contact\Repositories\PersonRepository;

$persons = app(PersonRepository::class);

$person = $persons->create([
    'name' => 'Jane Doe',
    'emails' => [['value' => 'jane@acme.test', 'label' => 'work']],
    'organization_name' => 'Acme Inc',
    'user_id' => 1,
]);

$persons->update(['job_title' => 'VP Sales'], $person->id);
$dupe = $persons->findOneWhere(['unique_id' => "1|5|jane@acme.test"]);
```

--------------------------------

### Create workflow using WorkflowRepository

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/automation.md

Example of creating a workflow via the WorkflowRepository. It includes conditions and actions for a big deal alert, and shows the validation entry point used by the listener.

```php
use Webkul\Automation\Repositories\WorkflowRepository;

$workflow = app(WorkflowRepository::class)->create([
    'name'           => 'Big deal alert',
    'entity_type'    => 'leads',
    'event'          => 'lead.create.after',
    'condition_type' => 'and',
    'conditions'     => [
        ['attribute' => 'lead_value', 'attribute_type' => 'price', 'operator' => '>=', 'value' => 50000],
    ],
    'actions'        => [
        ['id' => 'send_email_to_person', 'email_template_id' => 1],
        ['id' => 'trigger_webhook', 'webhook_id' => 1],
    ],
]);

// validation entry point used by the listener:
$valid = app(\Webkul\Automation\Helpers\Validator::class)->validate($workflow, $lead);
```

--------------------------------

### GET /configuration/{slug?}/{slug2?}/{path}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Downloads a configuration file field.

```APIDOC
## GET /configuration/{slug?}/{slug2?}/{path}

### Description
Downloads a configuration file field.

### Method
GET

### Endpoint
/configuration/{slug?}/{slug2?}/{path}

### Parameters
#### Path Parameters
- **slug** (string) - Optional - First slug segment.
- **slug2** (string) - Optional - Second slug segment.
- **path** (string) - Required - Path to the configuration file field.

```

--------------------------------

### QuoteRepository usage example

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/quote.md

Shows how to instantiate QuoteRepository and create a quote with line items, then update the quote's expiration date. The create method accepts an optional lead_id to sync lead products.

```php
use Webkul\Quote\Repositories\QuoteRepository;

$quotes = app(QuoteRepository::class);

$quote = $quotes->create([
    'subject'    => 'Q-1001',
    'person_id'  => 12,
    'lead_id'    => 7,
    'sub_total'  => 400,
    'grand_total'=> 400,
    'items'      => [
        ['product_id' => 1, 'quantity' => 2, 'price' => 200, 'discount_amount' => 0, 'tax_amount' => 0, 'total' => 400],
    ],
]);

$quotes->update(['expired_at' => now()->addDays(14)], $quote->id);
```

--------------------------------

### Bouncer usage example

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/admin-http.md

Shows how to check permissions and scope queries. Use bouncer()->hasPermission() to conditionally render admin-only controls, and getAuthorizedUserIds() to restrict lead/product/person listings for non-global users.

```php
if (bouncer()->hasPermission('settings.other_settings.web_forms')) {
    // render admin-only controls
}
$userIds = bouncer()->getAuthorizedUserIds(); // scope queries for non-global users
```

--------------------------------

### Usage of CountryStateRepository and core()

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/core-eloquent.md

Shows how to instantiate CountryStateRepository via the app container and use findByField to retrieve states by country code, and how to get a country name using the core() helper.

```php
use Webkul\Core\Repositories\CountryStateRepository;

$states = app(CountryStateRepository::class)->findByField('country_code', 'US');
$name = core()->country_name('IN');
```

--------------------------------

### GET /

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Redirects to the login page. This is the home route for the admin panel.

```APIDOC
## GET /

### Description
Redirects to the login page. This is the home route for the admin panel.

### Method
GET

### Endpoint
/

### Response
#### Success Response (302)
Redirect to login page.
```

--------------------------------

### GET/POST /configuration/{slug?}/{slug2?}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Renders the settings tab (GET) or saves configuration values (POST). The POST body is a map of tab key to field values, validated by ConfigurationForm.

```APIDOC
## GET/POST /configuration/{slug?}/{slug2?}

### Description
Renders the settings tab (GET) or saves configuration values (POST). The POST body is a map of tab key to field values, validated by ConfigurationForm.

### Method
GET, POST

### Endpoint
/configuration/{slug?}/{slug2?}

### Parameters
#### Path Parameters
- **slug** (string) - Optional - First slug segment.
- **slug2** (string) - Optional - Second slug segment.

### Request Body (POST)
- **{tab key}** (object) - Required - Map of field names to values.

```

--------------------------------

### POST /login

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Authenticates an administrator and starts a session. The request is throttled in-controller for failed attempts.

```APIDOC
## POST /login

### Description
Authenticates an administrator and starts a session. The request is throttled in-controller for failed attempts.

### Method
POST

### Endpoint
/login

### Parameters
#### Request Body
- **email** (string) - Required - Administrator email.
- **password** (string) - Required - Administrator password.
- **remember** (boolean) - Optional - Whether to remember the session.

### Response
#### Success Response (200)
Session started.
```

--------------------------------

### Instantiate and process the grid to get JSON payload

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/datagrid.md

Create a grid instance using the datagrid helper and call process() to return the JSON payload for the UI. This is typically used in a controller to respond to AJAX requests.

```php
$grid = datagrid(MyLeadGrid::class);
return $grid->process(); // JSON payload for the UI
```

--------------------------------

### GET /leads/create

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Displays the create form for a new lead. This endpoint is used to render the lead creation form.

```APIDOC
## GET /leads/create

### Description
Displays the create form for a new lead.

### Method
GET

### Endpoint
/leads/create

### Response
#### Success Response (200)
- Create form.

```

--------------------------------

### GET /quotes/create/{lead_id?}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Display the form to create a new quote, optionally pre-filled with a lead ID.

```APIDOC
## GET /quotes/create/{lead_id?}

### Description
Display the form to create a new quote, optionally pre-filled with a lead ID.

### Method
GET

### Endpoint
`/quotes/create/{lead_id?}`

### Parameters
#### Path Parameters
- **lead_id** (integer) - Optional - The ID of the lead to associate with the quote.

### Request Example
```
GET /quotes/create/123
```

### Response
#### Success Response (200)
- None specified

#### Response Example
```json
{}
```
```

--------------------------------

### GET /notifications

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Lists notifications.

```APIDOC
## GET /notifications

### Description
Lists notifications.

### Method
GET

### Endpoint
/notifications

```

--------------------------------

### GET /dashboard

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Displays the dashboard.

```APIDOC
## GET /dashboard

### Description
Displays the dashboard.

### Method
GET

### Endpoint
/dashboard

```

--------------------------------

### Usage of Core facade and core() helper

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/core.md

Shows how to access the Core service via the facade or helper function, including retrieving the version, countries collection, formatted price, and a configuration value.

```php
use Webkul\Core\Facades\Core;

$version = Core::version();                       // '2.2.7'
$countries = core()->countries();                 // Collection of Country models
$price = core()->formatBasePrice(1250.5);         // e.g. "$1,250.50"
$locale = core()->getConfigData('general.general.locale_settings.locale');
```

--------------------------------

### GET /dashboard/export-pdf

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Exports the dashboard as a PDF.

```APIDOC
## GET /dashboard/export-pdf

### Description
Exports the dashboard as a PDF.

### Method
GET

### Endpoint
/dashboard/export-pdf

```

--------------------------------

### GET /contacts/organizations

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Retrieves a list of organizations.

```APIDOC
## GET /contacts/organizations

### Description
Retrieves a list of organizations.

### Method
GET

### Endpoint
/contacts/organizations

```

--------------------------------

### GET /datagrid/datagrid/saved-filters

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Lists saved datagrid filters.

```APIDOC
## GET /datagrid/datagrid/saved-filters

### Description
Lists saved datagrid filters.

### Method
GET

### Endpoint
/datagrid/datagrid/saved-filters

```

--------------------------------

### Vite::set

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/core.md

Sets entry points for a given namespace. Throws ViterNotFound if the namespace is unknown.

```APIDOC
## `set`

### Description
Sets entry points for a given namespace. Throws ViterNotFound if the namespace is unknown.

### Method
`set`

### Signature
`public function set(mixed $entryPoints, string $namespace = 'admin'): mixed`

### Parameters
- `$entryPoints` (mixed) - Required - The entry points to set.
- `$namespace` (string) - Optional - The Vite namespace (default: `'admin'`).

### Returns
- Fluent `Vite` facade result.

### Throws
- `ViterNotFound` when the namespace is unknown.

### Example
```php
vite()->set(['src/Resources/assets/js/app.js'], 'admin');
```
```

--------------------------------

### GET /dashboard/stats

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Provides reporting statistics for the dashboard.

```APIDOC
## GET /dashboard/stats

### Description
Provides reporting statistics for the dashboard.

### Method
GET

### Endpoint
/dashboard/stats

```

--------------------------------

### Reading configuration values and resolving admin prefix

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/configuration.md

Shows how to read a stored configuration value via core()->getConfigData(), resolve the configured admin prefix with config('app.admin_path'), and select the inbound mail driver using config('mail-receiver.default'). The switch handles 'webklex-imap' (IMAP account from config('imap.accounts.default')) and 'sendgrid' (SendGrid Inbound Parse webhook) cases.

```php
// reading a stored configuration value
$color = core()->getConfigData('general.settings.menu_color');

// resolving the configured admin prefix
$adminPath = config('app.admin_path');

// driver selection for inbound mail
switch (config('mail-receiver.default')) {
    case 'webklex-imap': // IMAP account from config('imap.accounts.default')
    case 'sendgrid':     // SendGrid Inbound Parse webhook
}
```

--------------------------------

### GET /contacts/persons/search

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Performs a lookup search for persons.

```APIDOC
## GET /contacts/persons/search

### Description
Performs a lookup search for persons.

### Method
GET

### Endpoint
/contacts/persons/search

```

--------------------------------

### Campaign helper constructor and process method signature

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/marketing.md

Shows the constructor dependencies (EventRepository, CampaignRepository, PersonRepository) and the `process()` method signature for the `Webkul\Marketing\Helpers\Campaign` class. The `process()` method selects active campaigns with today's or null event dates, collects person emails, and queues `CampaignMail` for each.

```php
public function __construct(
    protected EventRepository $eventRepository,
    protected CampaignRepository $campaignRepository,
    protected PersonRepository $personRepository,
) {}

public function process(): void
```

--------------------------------

### GET /login

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Displays the login form for administrators.

```APIDOC
## GET /login

### Description
Displays the login form for administrators.

### Method
GET

### Endpoint
/login

### Response
#### Success Response (200)
Login form HTML.
```

--------------------------------

### Using EmailTemplateRepository to create and retrieve templates

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/email-template.md

Shows how to instantiate the repository and create a template with placeholder tokens, then retrieve all templates for the automation engine.

```php
use Webkul\EmailTemplate\Repositories\EmailTemplateRepository;

$templates = app(EmailTemplateRepository::class);

$template = $templates->create([
    'name'    => 'Deal closed',
    'subject' => 'Thanks, {%leads.person_name%}!',
    'content' => '<p>We appreciate your business — here is your receipt.</p>',
]);

// retrieve for the automation engine
$all = $templates->all(['id', 'name']);
```

--------------------------------

### POST /contacts/persons/google-export

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Starts a Google export for persons.

```APIDOC
## POST /contacts/persons/google-export

### Description
Starts a Google export for persons.

### Method
POST

### Endpoint
/contacts/persons/google-export

```

--------------------------------

### GET /mail/attachment-download/{id?}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Download an attachment from a private disk.

```APIDOC
## GET /mail/attachment-download/{id?}

### Description
Download an attachment from a private disk.

### Method
GET

### Endpoint
`/mail/attachment-download/{id?}`

### Parameters
#### Path Parameters
- **id** (integer) - Optional - The ID of the attachment to download.

### Request Example
```
GET /mail/attachment-download/123
```

### Response
#### Success Response (200)
- None specified

#### Response Example
```json
{}
```
```

--------------------------------

### GET /activities/download/{id}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Download a file associated with an activity.

```APIDOC
## GET /activities/download/{id}

### Description
Download a file associated with an activity.

### Method
GET

### Endpoint
`/activities/download/{id}`

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the activity whose file to download.

### Request Example
```
GET /activities/download/789
```

### Response
#### Success Response (200)
- None specified

#### Response Example
```json
{}
```
```

--------------------------------

### GET /activities/get

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Retrieve a specific activity or list of activities.

```APIDOC
## GET /activities/get

### Description
Retrieve a specific activity or list of activities.

### Method
GET

### Endpoint
`/activities/get`

### Parameters
#### Query Parameters
- None specified

### Request Example
```
GET /activities/get?id=123
```

### Response
#### Success Response (200)
- None specified

#### Response Example
```json
{}
```
```

--------------------------------

### Create warehouse and location via repositories

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/warehouse.md

Shows how to use WarehouseRepository and LocationRepository to create a warehouse and a location, then query the warehouse's locations.

```php
use Webkul\Warehouse\Repositories\WarehouseRepository;
use Webkul\Warehouse\Repositories\LocationRepository;

$warehouses = app(WarehouseRepository::class);

$warehouse = $warehouses->create([
    'name'            => 'Main DC',
    'contact_name'    => 'Ops Team',
    'contact_emails'  => [['value' => 'dc@acme.test', 'label' => 'work']],
    'contact_numbers' => [['value' => '+1 555 0100', 'label' => 'work']],
    'contact_address' => ['address' => '1 Warehouse Way', 'city' => 'Austin', 'country' => 'US'],
]);

$location = app(LocationRepository::class)->create([
    'name'         => 'Aisle A',
    'warehouse_id' => $warehouse->id,
]);

echo $warehouse->locations()->pluck('name')->join(', '); // 'Aisle A'
```

--------------------------------

### GET /quotes/search

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Search for quotes based on query parameters.

```APIDOC
## GET /quotes/search

### Description
Search for quotes based on query parameters.

### Method
GET

### Endpoint
`/quotes/search`

### Parameters
#### Query Parameters
- None specified

### Request Example
```
GET /quotes/search?term=example
```

### Response
#### Success Response (200)
- None specified

#### Response Example
```json
{}
```
```

--------------------------------

### GET /contacts/organizations/create

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Displays the form to create a new organization.

```APIDOC
## GET /contacts/organizations/create

### Description
Displays the form to create a new organization.

### Method
GET

### Endpoint
/contacts/organizations/create

```

--------------------------------

### GET /contacts/persons/view/{id}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Displays the details of a specific person.

```APIDOC
## GET /contacts/persons/view/{id}

### Description
Displays the details of a specific person.

### Method
GET

### Endpoint
/contacts/persons/view/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The person ID.

```

--------------------------------

### GET /contacts/persons/create

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Displays the form to create a new person.

```APIDOC
## GET /contacts/persons/create

### Description
Displays the form to create a new person.

### Method
GET

### Endpoint
/contacts/persons/create

```

--------------------------------

### Concord module registration configuration

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/configuration.md

Defines the modules array with 17 ModuleServiceProviders in boot order and enables route model registration. The DataTransfer module is listed twice but registration is idempotent.

```php
'modules' => [ /* 17 ModuleServiceProviders in boot order */ ],
'register_route_models' => true,
```

--------------------------------

### GET /forget-password

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Displays the password reset request form.

```APIDOC
## GET /forget-password

### Description
Displays the password reset request form.

### Method
GET

### Endpoint
/forget-password

### Response
#### Success Response (200)
Password reset request form HTML.
```

--------------------------------

### Creating an activity via ActivityRepository

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/activity.md

Use the ActivityRepository to create an activity with related leads and participants. The create method persists the activity along with participants, leads, persons, products, warehouses, and files payloads.

```php
use Webkul\Activity\Repositories\ActivityRepository;

$activities = app(ActivityRepository::class);

$activity = $activities->create([
    'title' => 'Follow-up call',
    'type' => 'call',
    'schedule_from' => now()->addDay()->format('Y-m-d H:i:s'),
    'schedule_to' => now()->addDay()->addHour()->format('Y-m-d H:i:s'),
    'user_id' => 1,
    'leads' => [1, 2],
    'participants' => [['user_id' => 2]],
]);
```

--------------------------------

### GET /mail/{route}/{id}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

View a specific email thread.

```APIDOC
## GET /mail/{route}/{id}

### Description
View a specific email thread.

### Method
GET

### Endpoint
`/mail/{route}/{id}`

### Parameters
#### Path Parameters
- **route** (string) - Required - The folder name.
- **id** (integer) - Required - The ID of the email thread.

### Request Example
```
GET /mail/inbox/456
```

### Response
#### Success Response (200)
- None specified

#### Response Example
```json
{}
```
```

--------------------------------

### GET /activities/edit/{id}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Display the form to edit an existing activity.

```APIDOC
## GET /activities/edit/{id}

### Description
Display the form to edit an existing activity.

### Method
GET

### Endpoint
`/activities/edit/{id}`

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the activity to edit.

### Request Example
```
GET /activities/edit/456
```

### Response
#### Success Response (200)
- None specified

#### Response Example
```json
{}
```
```

--------------------------------

### Tag repository usage with lead attachment

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/tag.md

Shows how to instantiate TagRepository, create a tag, attach it to a lead via the tags() relation, and run a searchable query using the 'name' field with a LIKE condition.

```php
use Webkul\Tag\Repositories\TagRepository;

$tags = app(TagRepository::class);

$tag = $tags->create([
    'name'    => 'VIP',
    'color'   => '#f97316',
    'user_id' => auth()->guard('user')->id(),
]);

// attach to a lead
$lead = app(\Webkul\Lead\Repositories\LeadRepository::class)->find(1);
$lead->tags()->attach($tag->id);

// searchable query through the repository
$vipTags = $tags->where('name', 'like', '%vip%')->get();
```

--------------------------------

### Register admin and front routes in AdminServiceProvider::boot()

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/admin-http.md

Shows how AdminServiceProvider::boot() registers the admin and front route groups. The admin routes use the 'web', 'admin_locale', and 'user' middleware, are prefixed with config('app.admin_path'), and load the Routes/Admin/web.php file. The front routes use 'web' and 'admin_locale' middleware and load Routes/Front/web.php.

```php
Route::middleware(['web', 'admin_locale', 'user'])
    ->prefix(config('app.admin_path'))
    ->group(__DIR__.'/../Routes/Admin/web.php');

Route::middleware(['web', 'admin_locale'])
    ->group(__DIR__.'/../Routes/Front/web.php');
```

--------------------------------

### GET /quotes/lead-products/{lead_id}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Retrieve products associated with a specific lead.

```APIDOC
## GET /quotes/lead-products/{lead_id}

### Description
Retrieve products associated with a specific lead.

### Method
GET

### Endpoint
`/quotes/lead-products/{lead_id}`

### Parameters
#### Path Parameters
- **lead_id** (integer) - Required - The ID of the lead.

### Request Example
```
GET /quotes/lead-products/123
```

### Response
#### Success Response (200)
- None specified

#### Response Example
```json
{}
```
```

--------------------------------

### GET /contacts/persons/{id}/activities

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Retrieves activities for a specific person.

```APIDOC
## GET /contacts/persons/{id}/activities

### Description
Retrieves activities for a specific person.

### Method
GET

### Endpoint
/contacts/persons/{id}/activities

### Parameters
#### Path Parameters
- **id** (integer) - Required - The person ID.

```

--------------------------------

### SystemConfig class skeleton

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/core.md

Shows the public API of the SystemConfig registry class, including its constructor and method signatures for managing configuration items and retrieving config data.

```php
class SystemConfig
{
    public array $items = [];

    public function __construct(protected CoreConfigRepository $coreConfigRepository) {}

    public function addItem(Item $item): void
    public function getItems(): Collection
    public function getActiveConfigurationItem(): ?Item
    public function getConfigField(string $fieldName): ?array
    public function getConfigData(string $field): mixed
}
```

--------------------------------

### GET /contacts/persons/edit/{id}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Displays the form to edit an existing person.

```APIDOC
## GET /contacts/persons/edit/{id}

### Description
Displays the form to edit an existing person.

### Method
GET

### Endpoint
/contacts/persons/edit/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The person ID.

```

--------------------------------

### GET /contacts/persons

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Retrieves a paginated list of persons for the datagrid view.

```APIDOC
## GET /contacts/persons

### Description
Retrieves a paginated list of persons for the datagrid view.

### Method
GET

### Endpoint
/contacts/persons

### Response
#### Success Response (200)
- Datagrid data for persons.

```

--------------------------------

### GET /account

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Displays the profile edit form for the authenticated administrator.

```APIDOC
## GET /account

### Description
Displays the profile edit form for the authenticated administrator.

### Method
GET

### Endpoint
/account

### Response
#### Success Response (200)
Profile edit form HTML.
```

--------------------------------

### LeadRepository constructor with injected repositories

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/lead.md

Constructor for Webkul\Lead\Repositories\LeadRepository that injects StageRepository, PersonRepository, ProductRepository, AttributeRepository, and AttributeValueRepository. The Container is also injected for dependency resolution.

```php
public function __construct(
    protected StageRepository $stageRepository,
    protected PersonRepository $personRepository,
    protected ProductRepository $productRepository,
    protected AttributeRepository $attributeRepository,
    protected AttributeValueRepository $attributeValueRepository,
    Container $container
) {}
```

--------------------------------

### Action Constructor

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/datagrid.md

Creates a new Action instance for the DataGrid. The constructor accepts parameters for the action's index, icon, title, method, and URL.

```APIDOC
## Action Constructor

### Description
Creates a new Action instance for the DataGrid. The constructor accepts parameters for the action's index, icon, title, method, and URL.

### Method
Constructor

### Endpoint
`Webkul\DataGrid\Action::__construct(string $index, string $icon, string $title, string $method, mixed $url)`

### Parameters
#### Request Body
- **index** (string) - Required - The action index.
- **icon** (string) - Required - The icon identifier.
- **title** (string) - Required - The action title.
- **method** (string) - Required - The HTTP method.
- **url** (mixed) - Required - A closure receiving the record.

### Response
#### Success Response
Returns a new `Action` instance.

#### Response Example
```php
new Action('edit', 'icon-edit', 'Edit', 'GET', function($record) { return '/edit/' . $record->id; })
```
```

--------------------------------

### UserRepository usage with Bouncer

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/user.md

Shows how to create a user via UserRepository and iterate over authorized user IDs using Bouncer. The 'view_permission' field controls data scope.

```php
use Webkul\User\Repositories\UserRepository;
use Webkul\Admin\Bouncer;

$users = app(UserRepository::class);

$user = $users->create([
    'name' => 'Alex',
    'email' => 'alex@acme.test',
    'password' => bcrypt('secret'),
    'role_id' => 2,
    'status' => 1,
    'view_permission' => 'group',
]);

foreach (bouncer()->getAuthorizedUserIds() ?? [auth()->guard('user')->id()] as $userId) {
    // rows visible to this user
}
```

--------------------------------

### addItem(Item $item): void

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/core.md

Appends a configuration tree item to the system config registry.

```APIDOC
## addItem(Item $item): void

### Description
Appends a config tree item to the system config registry.

### Method
addItem

### Parameters
- **$item** (Item) - Required - The configuration tree item to add.

### Return
void
```

--------------------------------

### GET /contacts/organizations/edit/{id?}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Displays the form to edit an organization. The ID is optional.

```APIDOC
## GET /contacts/organizations/edit/{id?}

### Description
Displays the form to edit an organization. The ID is optional.

### Method
GET

### Endpoint
/contacts/organizations/edit/{id?}

### Parameters
#### Path Parameters
- **id** (integer) - Optional - The organization ID.

```

--------------------------------

### GET /quotes/print/{id?}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Generate a PDF version of a quote, optionally with a given ID.

```APIDOC
## GET /quotes/print/{id?}

### Description
Generate a PDF version of a quote, optionally with a given ID.

### Method
GET

### Endpoint
`/quotes/print/{id?}`

### Parameters
#### Path Parameters
- **id** (integer) - Optional - The ID of the quote to print.

### Request Example
```
GET /quotes/print/789
```

### Response
#### Success Response (200)
- None specified

#### Response Example
```json
{}
```
```

--------------------------------

### GET /contacts/persons/google-export/{batch}/stats

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Retrieves statistics for a specific Google export batch.

```APIDOC
## GET /contacts/persons/google-export/{batch}/stats

### Description
Retrieves statistics for a specific Google export batch.

### Method
GET

### Endpoint
/contacts/persons/google-export/{batch}/stats

### Parameters
#### Path Parameters
- **batch** (string) - Required - The batch identifier.

```

--------------------------------

### Parser::__construct

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/email.md

Initializes a new Parser instance with an optional CharsetManager for charset-aware header decoding.

```APIDOC
## Parser::__construct

### Description
Initializes a new Parser instance with an optional CharsetManager for charset-aware header decoding.

### Method
`__construct`

### Parameters
- **$charset** (CharsetManager|null) - Optional - Charset manager for decoding headers.
```

--------------------------------

### GET /leads/search

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Performs a lookup search for leads. This endpoint is used for search functionality.

```APIDOC
## GET /leads/search

### Description
Performs a lookup search for leads.

### Method
GET

### Endpoint
/leads/search

### Response
#### Success Response (200)
- Search results.

```

--------------------------------

### system_config()

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/core.md

Resolves the 'system_config' service from the Laravel container. Returns an instance of Webkul\Core\SystemConfig.

```APIDOC
## system_config()

### Description
Resolves the 'system_config' service from the Laravel container. Returns an instance of Webkul\Core\SystemConfig.

### Returns
- `Webkul\Core\SystemConfig` - The system configuration service instance.

```

--------------------------------

### GET /reset-password/{token}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Displays the password reset form using the provided token.

```APIDOC
## GET /reset-password/{token}

### Description
Displays the password reset form using the provided token.

### Method
GET

### Endpoint
/reset-password/{token}

### Parameters
#### Path Parameters
- **token** (string) - Required - Password reset token.

### Response
#### Success Response (200)
Password reset form HTML.
```

--------------------------------

### Programmatically process campaigns via helper

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/marketing.md

Calls the `Campaign` helper's `process()` method directly to queue campaign emails for today's events. Requires importing `Webkul\Marketing\Helpers\Campaign`.

```php
use Webkul\Marketing\Helpers\Campaign;

app(Campaign::class)->process(); // queue campaign emails for today's events
```

--------------------------------

### GET /configuration/search

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Searches configuration settings. This endpoint is used to find configuration options by query.

```APIDOC
## GET /configuration/search

### Description
Searches configuration settings.

### Method
GET

### Endpoint
/configuration/search

```

--------------------------------

### GET /mail/{route?}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

List emails in a folder. The route must be a valid SupportedFolderEnum value.

```APIDOC
## GET /mail/{route?}

### Description
List emails in a folder. The route must be a valid SupportedFolderEnum value.

### Method
GET

### Endpoint
`/mail/{route?}`

### Parameters
#### Path Parameters
- **route** (string) - Optional - The folder name (must be a SupportedFolderEnum value).

### Request Example
```
GET /mail/inbox
```

### Response
#### Success Response (200)
- None specified

#### Response Example
```json
{}
```
```

--------------------------------

### Menu class definition and method signatures

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/core.md

Defines the Menu class with constants for admin and customer areas, and lists the public method signatures for building and querying the navigation tree. The constructor injects CoreConfigRepository.

```php
class Menu
{
    const ADMIN = 'admin';
    const CUSTOMER = 'customer';

    public function __construct(protected CoreConfigRepository $coreConfigRepository) {}

    public function addItem(MenuItem $menuItem): void
    public function getItems(?string $area = null, string $key = ''): Collection
    public function getAdminMenuByKey(array|string $keys): mixed
    public function getLabel(string $key, ?string $fallbackTransKey = null): string
    public function getCurrentActiveMenu(?string $area = null): ?MenuItem
}
```

--------------------------------

### GET /quotes/edit/{id?}

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/endpoints.md

Display the form to edit an existing quote, optionally with a given ID.

```APIDOC
## GET /quotes/edit/{id?}

### Description
Display the form to edit an existing quote, optionally with a given ID.

### Method
GET

### Endpoint
`/quotes/edit/{id?}`

### Parameters
#### Path Parameters
- **id** (integer) - Optional - The ID of the quote to edit.

### Request Example
```
GET /quotes/edit/456
```

### Response
#### Success Response (200)
- None specified

#### Response Example
```json
{}
```
```

--------------------------------

### Product model fillable

Source: https://github.com/krayin/laravel-crm/blob/2.2/_autodocs/api-reference/lead.md

Defines the fillable attributes for the Product model, including quantity, price, amount, product_id, and lead_id.

```php
protected $fillable = ['quantity', 'price', 'amount', 'product_id', 'lead_id'];
```
Tokens:
Raw