PHPackages                             iamarsenibragimov/loxo-laravel-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. iamarsenibragimov/loxo-laravel-api

ActiveLibrary[API Development](/categories/api)

iamarsenibragimov/loxo-laravel-api
==================================

Unofficial Laravel package for Loxo API integration

v1.1.3(8mo ago)241↓33.3%MITPHPPHP ^8.1

Since Aug 15Pushed 8mo agoCompare

[ Source](https://github.com/iamarsenibragimov/loxo-laravel-api)[ Packagist](https://packagist.org/packages/iamarsenibragimov/loxo-laravel-api)[ Docs](https://github.com/iamarsenibragimov/loxo-laravel-api)[ RSS](/packages/iamarsenibragimov-loxo-laravel-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (4)Versions (4)Used By (0)

Loxo Laravel API Package (Unofficial)
=====================================

[](#loxo-laravel-api-package-unofficial)

An **unofficial** Laravel package for easy integration with the [Loxo API](https://loxo.co). This package provides a simple and elegant way to interact with Loxo's recruitment platform API.

✨ Latest Updates
----------------

[](#-latest-updates)

🚀 **Major API Expansion**: Now supporting **56 endpoints** (38.9% coverage) with comprehensive functionality:

- 🌍 **Geography & Location**: Countries, states, cities, and currencies with hierarchical navigation
- 🏢 **Company Management**: Global statuses and types for client relationship management
- 📊 **Data Management**: Merges, question types, social profiles, and education types
- 👥 **Demographics & Diversity**: Genders, ethnicities, diversity types, and disability statuses
- 💰 **Compensation & Financial**: Fee types, equity types, and compensation classifications
- 📧 **Email & Communication**: Email types and advanced tracking with filtering
- ⚙️ **Configuration**: Seniority levels, pronouns, phone types, and person management

> ⚠️ **Disclaimer:** This is an unofficial package and is not affiliated with, endorsed by, or supported by Loxo. It is developed and maintained independently.
>
> 📚 **Official Resources:**
>
> - [Loxo Website](https://loxo.co) - Official Loxo platform
> - [Loxo API Documentation](https://loxo.readme.io/reference/loxo-api) - Official API reference

Installation
------------

[](#installation)

Install the package via Composer:

```
composer require iamarsenibragimov/loxo-laravel-api
```

Configuration
-------------

[](#configuration)

### 1. Publish the configuration file (optional):

[](#1-publish-the-configuration-file-optional)

```
php artisan vendor:publish --tag=loxo-config
```

### 2. Add your Loxo API credentials to your `.env` file:

[](#2-add-your-loxo-api-credentials-to-your-env-file)

```
LOXO_DOMAIN=your-domain.app.loxo.co
LOXO_AGENCY_SLUG=your-agency-slug
LOXO_API_KEY=your-api-key-here
```

### Optional Configuration

[](#optional-configuration)

You can also configure these optional settings in your `.env` file:

```
LOXO_TIMEOUT=30
LOXO_RETRY_ATTEMPTS=3
LOXO_RETRY_DELAY=1000
```

Usage
-----

[](#usage)

### Using the Facade

[](#using-the-facade)

The easiest way to use the package is through the `Loxo` facade:

```
use Loxo\LaravelApi\Facades\Loxo;

// Get activity types
$activityTypes = Loxo::getActivityTypes();

// Get activity types with parameters
$activityTypes = Loxo::getActivityTypes([
    'workflow_id' => 123,
    'show_hidden' => true
]);

// Get address types
$addressTypes = Loxo::getAddressTypes();

// Make custom GET request
$data = Loxo::get('custom-endpoint', ['param' => 'value']);

// Make custom POST request
$result = Loxo::post('custom-endpoint', ['data' => 'value']);
```

### Using Dependency Injection

[](#using-dependency-injection)

You can also inject the service directly into your classes:

```
use Loxo\LaravelApi\Contracts\LoxoApiInterface;

class YourController extends Controller
{
    public function __construct(
        private LoxoApiInterface $loxoApi
    ) {}

    public function getActivityTypes()
    {
        try {
            $activityTypes = $this->loxoApi->getActivityTypes();
            return response()->json($activityTypes);
        } catch (\Loxo\LaravelApi\Exceptions\LoxoApiException $e) {
            return response()->json([
                'error' => $e->getMessage(),
                'response' => $e->getResponse()
            ], $e->getCode());
        }
    }
}
```

### Available Methods

[](#available-methods)

> **📊 API Coverage Status:** Currently 56 out of 144+ Loxo API endpoints are implemented (38.9%). See [API\_COVERAGE.md](docs/API_COVERAGE.md) for complete endpoint coverage status and details.
>
> 📖 **Reference:** All endpoints are based on the [official Loxo API documentation](https://loxo.readme.io/reference/loxo-api).

#### Quick Examples

[](#quick-examples)

```
// Get all people (candidates)
$people = Loxo::getPeople();

// Search for people with filters
$people = Loxo::getPeople([
    'query' => 'software engineer',
    'person_global_status_id' => 1,
    'per_page' => 20
]);

// Create a new person/candidate
$newPerson = Loxo::createPerson([
    'person' => [
        'name' => 'John Doe',
        'email' => 'john.doe@example.com',
        'title' => 'Software Engineer'
    ]
]);

// Get all companies
$companies = Loxo::getCompanies();

// Get jobs and their candidates
$jobs = Loxo::getJobs();
$jobCandidates = Loxo::getJobCandidates(456);

// Create person events
$newEvent = Loxo::createPersonEvent([
    'person_event' => [
        'activity_type_id' => 1,
        'person_id' => 456,
        'notes' => 'Interview completed'
    ]
]);

// Manage webhooks
$webhooks = Loxo::getWebhooks();
$newWebhook = Loxo::createWebhook([
    'webhook' => [
        'item_type' => 'candidate',
        'action' => 'create',
        'endpoint_url' => 'https://myapp.com/webhooks/candidate-created'
    ]
]);
```

```
// SMS Messages
$smsMessages = Loxo::getSms([
    'per_page' => 10,
    'created_at_start' => '2024-01-01T00:00:00Z'
]);

// Send SMS
$newSms = Loxo::createSms([
    'from_number' => '+1234567890',
    'to_number' => '+0987654321',
    'body' => 'Hello! This is a test SMS.',
    'job_id' => 123,
    'person_id' => 456
]);

// Get specific SMS
$sms = Loxo::getSmsById(123);

// Get seniority levels for job positions
$seniorityLevels = Loxo::getSeniorityLevels();

// Get scorecard visibility types for evaluation settings
$visibilityTypes = Loxo::getScorecardVisibilityTypes();

// Get available scorecard types
$scorecardTypes = Loxo::getScorecardTypes();

// Get pronouns for person profiles
$pronouns = Loxo::getPronouns();

// Get phone types for contact information
$phoneTypes = Loxo::getPhoneTypes();

// Get person types for classification
$personTypes = Loxo::getPersonTypes();

// Get person share field types for data sharing configuration
$shareFieldTypes = Loxo::getPersonShareFieldTypes();

// Get person lists for candidate organization
$personLists = Loxo::getPersonLists();

// Geography & Location Management
$countries = Loxo::getCountries([
    'query' => 'United',
    'per_page' => 10
]);

$states = Loxo::getStates(1, [
    'query' => 'California'
]);

$cities = Loxo::getCities(1, 1, [
    'per_page' => 25
]);

$currencies = Loxo::getCurrencies();

// Company Management
$companyStatuses = Loxo::getCompanyGlobalStatuses();
$companyTypes = Loxo::getCompanyTypes();

// Data Management
$merges = Loxo::getMerges([
    'item_type' => 'person',
    'per_page' => 20
]);

$questionTypes = Loxo::getQuestionTypes();
$socialProfileTypes = Loxo::getSocialProfileTypes();
$educationTypes = Loxo::getEducationTypes();

// Demographics & Diversity
$genders = Loxo::getGenders();
$ethnicities = Loxo::getEthnicities();
$diversityTypes = Loxo::getDiversityTypes();
$disabilityStatuses = Loxo::getDisabilityStatuses();

// Compensation & Financial
$feeTypes = Loxo::getFeeTypes();
$equityTypes = Loxo::getEquityTypes();
$compensationTypes = Loxo::getCompensationTypes();

// Email & Communication
$emailTypes = Loxo::getEmailTypes();
$emailTracking = Loxo::getEmailTracking([
    'person_ids' => [123, 456],
    'created_at_start' => '2024-01-01T00:00:00Z'
]);
```

For a complete list of all available methods, filters, and parameters, please see [API\_COVERAGE.md](docs/API_COVERAGE.md).

#### Generic HTTP Methods

[](#generic-http-methods)

```
// GET request
$data = Loxo::get('endpoint', ['query' => 'params']);

// POST request
$result = Loxo::post('endpoint', ['data' => 'to-send']);

// PUT request
$result = Loxo::put('endpoint', ['data' => 'to-update']);

// DELETE request
$result = Loxo::delete('endpoint');
```

#### Utility Methods

[](#utility-methods)

```
// Get base API URL
$baseUrl = Loxo::getBaseUrl();

// Get agency slug
$agencySlug = Loxo::getAgencySlug();

// Get domain
$domain = Loxo::getDomain();
```

### LoxoApiException

[](#loxoapiexception)

Thrown when API requests fail:

```
use Loxo\LaravelApi\Exceptions\LoxoApiException;

try {
    $data = Loxo::getActivityTypes();
} catch (LoxoApiException $e) {
    // Get the error message
    $message = $e->getMessage();

    // Get the HTTP status code
    $statusCode = $e->getCode();

    // Get the API response (if available)
    $response = $e->getResponse();

    Log::error('Loxo API Error', [
        'message' => $message,
        'code' => $statusCode,
        'response' => $response
    ]);
}
```

### ConfigurationException

[](#configurationexception)

Thrown when required configuration is missing:

```
use Loxo\LaravelApi\Exceptions\ConfigurationException;

try {
    $data = Loxo::getActivityTypes();
} catch (ConfigurationException $e) {
    // Handle missing configuration
    Log::error('Loxo API Configuration Error: ' . $e->getMessage());
}
```

Advanced Usage
--------------

[](#advanced-usage)

### Retry Logic

[](#retry-logic)

The package includes built-in retry logic for failed requests. You can configure the retry behavior in your config file:

```
// config/loxo.php
return [
    'retry_attempts' => 3,      // Number of retry attempts
    'retry_delay' => 1000,      // Delay between retries in milliseconds
];
```

### Timeout Configuration

[](#timeout-configuration)

You can configure the request timeout:

```
// config/loxo.php
return [
    'timeout' => 30, // Timeout in seconds
];
```

Quick Development Testing
-------------------------

[](#quick-development-testing)

For rapid testing during development, create a `.env` file in the package root:

```
# .env
LOXO_DOMAIN=your-domain.app.loxo.co
LOXO_AGENCY_SLUG=your-agency-slug
LOXO_API_KEY=your-api-key-here
```

Then use these make commands:

```
# Quick test all endpoints
make quick

# Test all new endpoints at once
make test-new-endpoints

# Test endpoint categories
make test-geography        # Countries, states, cities, currencies
make test-company         # Company statuses and types
make test-demographics    # Genders, ethnicities, diversity types
make test-compensation    # Fee types, equity types, compensation types
make test-communication   # Email types, email tracking, SMS
make test-configuration   # Seniority levels, pronouns, phone types, etc.

# Test specific endpoints
make activity-types
make countries
make company-types
make genders
make email-tracking

# Debug configuration
make debug-config

# Run unit tests
make test
```

Or run the test script directly:

```
php dev-bootstrap.php
```

### Available Make Commands

[](#available-make-commands)

```
# General Commands
make help                    # Show all available commands
make quick                   # Quick test all endpoints
make test-new-endpoints      # Test all newly implemented endpoints
make debug-config           # Show current configuration
make test                   # Run automated tests
make install                # Install dependencies
make clean                  # Clean vendor directory
make lint                   # Check code style

# Category Testing Commands
make test-geography         # Test geography endpoints (countries, states, cities, currencies)
make test-company          # Test company endpoints (statuses, types)
make test-data-management  # Test data management endpoints (merges, question types, etc.)
make test-demographics     # Test demographics endpoints (genders, ethnicities, etc.)
make test-compensation     # Test compensation endpoints (fee types, equity types, etc.)
make test-communication    # Test communication endpoints (email types, tracking, SMS)
make test-configuration    # Test configuration endpoints (seniority levels, pronouns, etc.)

# Individual Endpoint Commands (examples)
make activity-types        # Test activity types endpoint
make countries            # Test countries endpoint
make states               # Test states endpoint
make cities               # Test cities endpoint
make company-types        # Test company types endpoint
make genders              # Test genders endpoint
make email-tracking       # Test email tracking endpoint
make disability-statuses  # Test disability statuses endpoint
# ... and many more (33+ individual endpoint commands available)
```

Testing in Laravel Applications
-------------------------------

[](#testing-in-laravel-applications)

The package is designed to be easily testable. You can mock the `LoxoApiInterface` in your tests:

```
use Loxo\LaravelApi\Contracts\LoxoApiInterface;
use Mockery;

public function test_something()
{
    $mockLoxoApi = Mockery::mock(LoxoApiInterface::class);
    $mockLoxoApi->shouldReceive('getActivityTypes')
        ->once()
        ->andReturn(['activity_types' => []]);

    $this->app->instance(LoxoApiInterface::class, $mockLoxoApi);

    // Your test code here
}
```

Requirements
------------

[](#requirements)

- PHP 8.1 or higher
- Laravel 10.0 or higher
- Guzzle HTTP client 7.0 or higher

License
-------

[](#license)

This package is open-sourced software licensed under the [MIT license](LICENSE).

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING.md](docs/CONTRIBUTING.md) for details on how to contribute to this project.

Support
-------

[](#support)

If you discover any security vulnerabilities or bugs, please create an issue on GitHub.

🤝 Sponsors & Supporters
---------------------------

[](#-sponsors--supporters)

This project is proudly supported by:

### [Topliner](https://topliner.app)

[](#topliner)

**AI Executive Search Copilot** - Revolutionizing executive recruitment with AI-powered search and matching capabilities.

### [Navis](https://getnavis.app)

[](#navis)

**Executive Talent Mapping - AI Accelerated, Expert Validated** - Advanced talent mapping solutions for executive search professionals.

### [TheBigSearch](https://thebigsearch.com)

[](#thebigsearch)

**We find Europe's top software and hardware leaders** - Specialized executive search for technology leadership positions across Europe.

📚 Documentation
---------------

[](#-documentation)

- **[🚀 Quick Start Guide](docs/QUICK_START.md)** - Get started in 5 minutes
- **[🧪 Testing Guide](docs/TESTING.md)** - Development and automated testing
- **[🤝 Contributing Guide](docs/CONTRIBUTING.md)** - How to contribute to development
- **[📊 API Coverage](docs/API_COVERAGE.md)** - Track implemented vs available endpoints

Changelog
---------

[](#changelog)

Please see [CHANGELOG.md](CHANGELOG.md) for more information on what has changed recently.

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance59

Moderate activity, may be stable

Popularity13

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~6 days

Total

3

Last Release

258d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/6703684?v=4)[Arsen Ibragimov](/maintainers/iamarsenibragimov)[@iamarsenibragimov](https://github.com/iamarsenibragimov)

---

Top Contributors

[![iamarsenibragimov](https://avatars.githubusercontent.com/u/6703684?v=4)](https://github.com/iamarsenibragimov "iamarsenibragimov (37 commits)")

---

Tags

apilaravelcrmunofficialATSrecruitmentloxohiring

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/iamarsenibragimov-loxo-laravel-api/health.svg)

```
[![Health](https://phpackages.com/badges/iamarsenibragimov-loxo-laravel-api/health.svg)](https://phpackages.com/packages/iamarsenibragimov-loxo-laravel-api)
```

###  Alternatives

[smodav/mpesa

M-Pesa API implementation

16363.7k1](/packages/smodav-mpesa)[ardakilic/mutlucell

Mutlucell SMS API wrapper for sending sms text messages for Laravel

457.3k](/packages/ardakilic-mutlucell)[dariusiii/tmdb-laravel

Laravel Package for TMDB ( The Movie Database ) API. Provides easy access to the wtfzdotnet/php-tmdb-api library.

1821.1k](/packages/dariusiii-tmdb-laravel)[dotzero/laravel-amocrm

ServiceProvider и Facade для Laravel 5 предоставляющие интеграцию с API amoCRM

3229.2k](/packages/dotzero-laravel-amocrm)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)