Create amazing tools
around your PIM with the API

Show me the endpoints!
Build amazing tools on top of your favorite PIM

Getting started guides

Play around with Postman!

With our Postman collection, the API power at your hands in just a few minutes
Make your first request

Whether you are using the PHP API client or curl, your way to go
Manage the API connections

Create your first credentials and configure your rights to access the API

Tools, tools, tools...

Our PHP API client

You're a proud PHP developer? Don't bother working with REST calls, try our PHP client! Brought with love to you.
Our Swagger spec

Wanna dig deeper into the API? Here is our full API specification, in Swagger format.
Our Postman collection

The easiest way to start with the API endpoints. Experiment, test, make demos of the API thanks to this powerful tool!

Quick resources access

Community & Enterprise Editions

Product

Product model

Category

Family

Attribute

Attribute group

Association type

Channel

Locale

Product media file

Currency

Measure family

Enterprise Edition Only

Published product

Product draft

Product model draft

Reference entity

Reference entity attribute

Reference entity record

Reference entity media file

Asset

Asset category

Want more?

Security

From authentication to authorization, all you need to know about security.
Handling pagination

How it works and all you need to request large database of products.
Error responses

You just got a 401 and do not know what to do. Here is your solution!
From old to new

You were using the API in 1.6. Here is a mini-guide to help you migrate your code.
Update data

Merging data can be a little bit tricky. Here is the guide to serene updates.
Filter products

You want to be able to retrieve only the products you need. Filters are here to help.

Wanna contribute?

The API itself

Want more endpoints? Open source we are! Do not hesitate to help us build the API. The more endpoints, the better!
This API documentation website

Spotted a typo, or even a hole? Help us get better with our documentation. All contributions are warmly welcomed!

Need inspiration?

Join us on the marketplace and take a look to what our beloved community already built around Akeneo

Our API roadmap

Where are we heading?

Here you will find our roadmap for the next version of the API #transparency