PHPackages                             inuar/reference-data-api-bundle - 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. inuar/reference-data-api-bundle

ActiveSymfony-bundle[API Development](/categories/api)

inuar/reference-data-api-bundle
===============================

Akeneo PIM bundle to expose reference data via API

00

Since May 4Compare

[ Source](https://github.com/inuartech/ReferenceDataApiBundle)[ Packagist](https://packagist.org/packages/inuar/reference-data-api-bundle)[ RSS](/packages/inuar-reference-data-api-bundle/feed)WikiDiscussions Synced 3w ago

READMEChangelogDependenciesVersions (1)Used By (0)

Inuar Reference Data API Bundle
===============================

[](#inuar-reference-data-api-bundle)

A Symfony bundle for Akeneo PIM that exposes reference data entities via a REST API.

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

[](#requirements)

- PHP >= 8.1
- Symfony ^5.4
- Doctrine DBAL ^2.13.4
- Akeneo PIM with `CustomEntityBundle` installed

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

[](#installation)

Install via Composer:

```
composer require inuar/reference-data-api-bundle
```

Register the bundle in your Akeneo application's `config/bundles.php`:

```
return [
    // ...
    Inuar\Bundle\ReferenceDataApiBundle\InuarReferenceDataApiBundle::class => ['all' => true],
];
```

Import the bundle routes in your `config/routes.yaml`:

```
inuar_reference_data_api:
    resource: "@InuarReferenceDataApiBundle/Resources/config/routing.yml"
```

API Endpoints
-------------

[](#api-endpoints)

All endpoints are read-only and return JSON.

### List all records for a reference data entity

[](#list-all-records-for-a-reference-data-entity)

```
GET /rest/v1/reference-data/{entityName}

```

Returns an array of all records for the given entity, each normalised to the `standard` format.

**Example:**

```
GET /rest/v1/reference-data/color

```

```
[
    { "code": "red", "labels": { "en_US": "Red" } },
    { "code": "blue", "labels": { "en_US": "Blue" } }
]
```

### Get a single record by code

[](#get-a-single-record-by-code)

```
GET /rest/v1/reference-data/{entityName}/{code}

```

Returns a single record matching the given `code`. Responds with `404 Not Found` if the entity type or the specific record does not exist.

**Example:**

```
GET /rest/v1/reference-data/color/red

```

```
{ "code": "red", "labels": { "en_US": "Red" } }
```

How It Works
------------

[](#how-it-works)

The bundle resolves `{entityName}` against Akeneo's `CustomEntityBundle` configuration registry to find the corresponding entity class, then queries the database via Doctrine and serialises results using Akeneo's `pim_serializer` with the `standard` normalisation format.

License
-------

[](#license)

This bundle is developed by Inuar Technology and released under the MIT license.

###  Health Score

9

—

LowBetter than 0% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity0

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity12

Early-stage or recently created project

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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/8104c8ab80e70e6e383abf961bed5e9502062e8ed2587dcaa7bd8152ab93378b?d=identicon)[inuar](/maintainers/inuar)

### Embed Badge

![Health badge](/badges/inuar-reference-data-api-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/inuar-reference-data-api-bundle/health.svg)](https://phpackages.com/packages/inuar-reference-data-api-bundle)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35916.4M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24016.2M20](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172445.0k18](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93459.5k6](/packages/botman-driver-telegram)

PHPackages © 2026

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