PHPackages                             squidex/squidex - 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. [HTTP & Networking](/categories/http)
4. /
5. squidex/squidex

ActiveLibrary[HTTP & Networking](/categories/http)

squidex/squidex
===============

Client SDK for Squidex Headless CMS

1.2.1(1y ago)02.9k↑90%[1 PRs](https://github.com/Squidex/sdk-php/pulls)MITPHPPHP ^7.4 || ^8.0CI passing

Since Sep 5Pushed 1y ago1 watchersCompare

[ Source](https://github.com/Squidex/sdk-php)[ Packagist](https://packagist.org/packages/squidex/squidex)[ Docs](https://github.com/squidex/sdk-php)[ RSS](/packages/squidex-squidex/feed)WikiDiscussions main Synced 3d ago

READMEChangelog (5)Dependencies (4)Versions (8)Used By (0)

Squidex PHP Library
===================

[](#squidex-php-library)

The Squidex PHP library provides access to the Squidex API from PHP.

Requires **PHP 7** or higher.

Status
------

[](#status)

[![Version Shield](https://camo.githubusercontent.com/bd1e6be7437fdf64df194876bac40953f0fd6c7f93793f7e431b06125dcd540c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f737175696465782f73646b2d7068703f6c6162656c3d7061636b6167697374)](https://packagist.org/packages/squidex/squidex)[![Packagist PHP Version](https://camo.githubusercontent.com/4ede84ab511d9d8163ded5439a1518db1c66c5a55cde5927e68676a6e438c2f9/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f737175696465782f737175696465782f706870)](https://camo.githubusercontent.com/4ede84ab511d9d8163ded5439a1518db1c66c5a55cde5927e68676a6e438c2f9/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f737175696465782f737175696465782f706870)

Documentation
-------------

[](#documentation)

API reference documentation is available [here](https://cloud.squidex.io/api/docs).

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

[](#installation)

```
composer install @squidex/squidex
```

Usage
-----

[](#usage)

```
use Squidex\Client\Configuration;
use Squidex\Client\SquidexClient;

require_once __DIR__ . '/../vendor/autoload.php';

$config = new Configuration();
$config->setClientId('client-id');
$config->setClientSecret('client-secret');
$config->setAppName('my-app');
// $config->setHost('https://your.squidex-deployment');

$client = new SquidexClient($config);

$response = $client->rules()->runRule("rule-id", true);

echo "Received response from Squidex!\n$response\n";
```

Handling errors
---------------

[](#handling-errors)

When the API returns a non-success status code (4xx or 5xx response), a subclass of [ApiException](https://github.com/Squidex/sdk-php/blob/main/lib/ApiException.php) will be thrown:

```
use Squidex\Client\ApiException;

try {
    $response = $client->rules()->runRule("rule-id", true);
} catch (err) {
  if (ApiException $) {
    echo $e->getMessage();
  }
}
```

Generation Config
-----------------

[](#generation-config)

To generate the config you have to execute the following steps.

1. Run a Squidex version locally.
2. Run the `/api/docs` URL to get the OpenAPI spec.
3. Copy the OpenAPI spec to this repository.
4. Run the generator:

```
docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate -i /local/openapi.json -g php --template-dir  /local/templates -o /local/ -c /local/openapi-config.yml

```

### Releases

[](#releases)

To create a new release, just create a tag. Packagist will use this tag to calculate the version.

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

[](#contributing)

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

###  Health Score

34

—

LowBetter than 75% of packages

Maintenance41

Moderate activity, may be stable

Popularity21

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 84.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 ~90 days

Total

5

Last Release

671d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/dfec9b6b308ae553146ea5aab8c7bd31c4eee725604cbaa55c85db45514f42a6?d=identicon)[sebastian@squidex.io](/maintainers/sebastian@squidex.io)

---

Top Contributors

[![SebastianStehle](https://avatars.githubusercontent.com/u/1236435?v=4)](https://github.com/SebastianStehle "SebastianStehle (43 commits)")[![Liketodev2](https://avatars.githubusercontent.com/u/58598132?v=4)](https://github.com/Liketodev2 "Liketodev2 (6 commits)")[![adeveloper67](https://avatars.githubusercontent.com/u/116815206?v=4)](https://github.com/adeveloper67 "adeveloper67 (1 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (1 commits)")

---

Tags

phpapisdkrestopenapiheadlessopenapitoolsopenapi-generatorheadless cms

###  Code Quality

TestsPHPUnit

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/squidex-squidex/health.svg)

```
[![Health](https://phpackages.com/badges/squidex-squidex/health.svg)](https://phpackages.com/packages/squidex-squidex)
```

###  Alternatives

[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

273.0k](/packages/eslazarev-wildberries-sdk)[elasticemail/elasticemail-php

The PHP library for the Elastic Email REST API. This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. To start using this API, you will need your Access Token. Remember to keep it safe.

15114.7k2](/packages/elasticemail-elasticemail-php)

PHPackages © 2026

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