PHPackages                             fw4/organimmo-rental-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. fw4/organimmo-rental-api

ActiveLibrary[API Development](/categories/api)

fw4/organimmo-rental-api
========================

PHP library for implementing the Organimmo rental API

v1.3.1(8mo ago)11.1k↓75%2MITPHPPHP ^7.4|^8.0|^8.1CI passing

Since Apr 9Pushed 8mo ago3 watchersCompare

[ Source](https://github.com/fw4-bvba/organimmo-rental-api)[ Packagist](https://packagist.org/packages/fw4/organimmo-rental-api)[ RSS](/packages/fw4-organimmo-rental-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (5)Versions (13)Used By (0)

Organimmo rental API
====================

[](#organimmo-rental-api)

PHP client for the [Organimmo](https://www.organimmo.be) rental API. For terms of use and API credentials, refer to [the official documentation](https://api-docs.verhuur.expert/).

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

[](#installation)

`composer require fw4/organimmo-rental-api`

Usage
-----

[](#usage)

```
use Organimmo\Rental\Organimmo;

$client = new Organimmo('customer-id');

// Retrieve existing access token from storage (getAccessTokenFromDataStore to be implemented)
$accessToken = getAccessTokenFromDataStore();

if (empty($accessToken) || $accessToken->hasExpired()) {
	// Request and store new access token (saveAccessTokenToDataStore to be implemented)
	$accessToken = $client->requestAccessToken('client-id', 'client-secret', 'username', 'password');
    saveAccessTokenToDataStore($accessToken);
} else {
    $client->setAccessToken($accessToken);
}
```

All endpoints are available as methods of the Organimmo class. For more information about available endpoints and response format, refer to [the official API documentation](https://api-docs.verhuur.expert/).

### Retrieving objects by ID

[](#retrieving-objects-by-id)

Call `get($id)` on an endpoint to retrieve a specific object by ID. If no object exists with the provided ID, null is returned.

```
$country = $client->countries()->get(1);

if (is_null($country)) echo 'Country does not exist' . PHP_EOL;
else echo $country->name . PHP_EOL;
```

### Listing objects

[](#listing-objects)

Call `get()` on an endpoint to retrieve a traversable list of objects. Any pagination that's required happens automatically.

```
$countries = $client->countries()->get();

foreach ($countries as $country) {
	echo $country->name . PHP_EOL;
}
```

Some endpoints may themselves provide additional methods for retrieving related objects. These methods usually accept the ID of the relevant parent object. Like with other endpoints, chain `get()` on these methods to retrieve a traversable list of objects.

```
$rental_unit_id = 1;
$photos = $client->rentalUnits()->photos($rental_unit_id)->get();
```

### Related objects in responses

[](#related-objects-in-responses)

Responses may contain references to related objects. The actual data of these objects is not present in the response by default, but can easily be retrieved by calling `get()` on the pointer object.

```
$city = $client->cities()->get(1);
$country = $city->country->get();
echo $country->name . PHP_EOL;
```

Alternatively, it is possible to use the `depth` method to pre-fetch related objects. Pass an integer from 1 to 5 to determine how many levels to pre-fetch.

```
$city = $client->cities()->depth(1)->get(1);
echo $city->country->name . PHP_EOL;
```

### Sorting results

[](#sorting-results)

Use the `sort('fieldname')` method to order results by a specific property.

```
$countries = $client->countries()->sort('name')->get();
```

### Filtering results by date

[](#filtering-results-by-date)

Use the `from($date)` and `to($date)` methods to filter results by modification or creation date. These methods accept DateTime objects.

```
$countries = $client->countries()->from(date_create('2020-01-01'))->to(date_create('2020-06-01'))->get();
```

License
-------

[](#license)

`fw4/organimmo-rental-api` is licensed under the MIT License (MIT). Please see [LICENSE](LICENSE) for more information.

###  Health Score

45

—

FairBetter than 92% of packages

Maintenance62

Regular maintenance activity

Popularity20

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity72

Established project with proven stability

 Bus Factor1

Top contributor holds 93.3% 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 ~248 days

Recently: every ~293 days

Total

9

Last Release

240d ago

PHP version history (3 changes)1.0.0PHP ^7.1

1.1.0PHP ^7.1|^8.0

1.2.0PHP ^7.4|^8.0|^8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/2fe7a44c5e07cf8dd0eed2941b88dcab03342fb149ede5347b3467bc17691d4e?d=identicon)[Fyrts](/maintainers/Fyrts)

---

Top Contributors

[![fyrts](https://avatars.githubusercontent.com/u/5918336?v=4)](https://github.com/fyrts "fyrts (14 commits)")[![DeKerpelLaurent](https://avatars.githubusercontent.com/u/7040102?v=4)](https://github.com/DeKerpelLaurent "DeKerpelLaurent (1 commits)")

---

Tags

apisdkorganimmo

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/fw4-organimmo-rental-api/health.svg)

```
[![Health](https://phpackages.com/badges/fw4-organimmo-rental-api/health.svg)](https://phpackages.com/packages/fw4-organimmo-rental-api)
```

###  Alternatives

[openai-php/laravel

OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API

3.7k7.6M74](/packages/openai-php-laravel)[mailchimp/transactional

458.9M16](/packages/mailchimp-transactional)[resend/resend-php

Resend PHP library.

564.7M21](/packages/resend-resend-php)[checkout/checkout-sdk-php

Checkout.com SDK for PHP

553.3M7](/packages/checkout-checkout-sdk-php)[mozex/anthropic-laravel

Anthropic PHP for Laravel is a supercharged PHP API client that allows you to interact with the Anthropic API

71226.4k1](/packages/mozex-anthropic-laravel)

PHPackages © 2026

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