PHPackages                             idoit/zenkit-api-client - 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. idoit/zenkit-api-client

ActiveLibrary[API Development](/categories/api)

idoit/zenkit-api-client
=======================

A PHP API client library for Zenkit.

0.3.2(5y ago)7249MITPHPPHP >=7.1CI failing

Since Dec 18Pushed 4y ago1 watchersCompare

[ Source](https://github.com/leonardfischer/zenkit-api-client)[ Packagist](https://packagist.org/packages/idoit/zenkit-api-client)[ Docs](https://github.com/leonardfischer/zenkit-api-client)[ RSS](/packages/idoit-zenkit-api-client/feed)WikiDiscussions master Synced 5d ago

READMEChangelog (5)Dependencies (6)Versions (6)Used By (0)

zenkit-api-client
=================

[](#zenkit-api-client)

A PHP API client library for Zenkit. In order to use the API you'll need to get a API key from Zenkit, you can read about that in the [Zenkit API documentation](https://zenkit.com/docs/api/overview/introduction).

Please note that a API key is always connected to a user, so you might want to create a 'system' user with access to all your workspaces if you plan to develop an application that needs to process data you might not be allowed to see.

Testing the connection
----------------------

[](#testing-the-connection)

In order to test your connection you can simply call information about your user:

```
$apiKey = 'your-api-key';

try {
    // Get the response from Guzzle.
    $response = (new API($apiKey))->request('auth/currentuser');

    // Get the body contents of the response.
    $rawResponseBody = $response->getBody()->getContents();

    // Output data as array.
    var_dump(json_decode($rawResponseBody, true));
} catch (idoit\zenkit\BadResponseException $e) {
    echo 'Exception! The status was ' . $e->getCode() . ', response: ' . $e->getResponse()->getBody()->getContents();
} catch (Exception $e) {
    echo 'Exception! Somewthing else went wrong: ' . $e->getMessage();
}
```

If you see an array with information about your user it was a success - you should see data like your user ID, short ID, UUID, initials, full name, your recent lists and a lot of other things.

Good to know
============

[](#good-to-know)

Naming
------

[](#naming)

In the API context some components have other names, for example "Collections" are called "Lists" and "Fields" are called "Elements".

For this please also refer to the [API documentation](https://zenkit.com/docs/api/overview/naming-convention).

Mapped / raw responses
----------------------

[](#mapped--raw-responses)

By default your responses will be 'mapped' to class instances. This means that all data ('Elements', 'Entries', 'Lists', ...) will be mapped to according `*Item` class instances (`ElementItem`, `EntryItem`, `ListItem`, ...).

Retrieving objects will help you work with Zenkit data regarding code completion and look inside the class what data (and data types!) you will receive from Zenkit.

If -however- you prefer handling raw data instead of mapped objects you have two options:

- You can directly use the `$api->request()` Method and work with the Guzzle response object
- You can switch the API to deliver raw data when using the service classes via `setRawOutput` method

Entry / element definition
--------------------------

[](#entry--element-definition)

In order to map "elements" to entries and read their content you will need to load elements first and pass them to the entry service, like this:

```
$listShortId = 'your-list-short-id';

$elements = $api->getElementService()
    ->getElementsInList($listShortId);

$entries = $api->getEntryService()
    ->setElementConfiguration($elements)
    ->getEntriesForListView($listShortId);
```

Without the passed configuration you will not get mapped entry data - you will only be able to process the data if you retrieve 'raw' results.

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community7

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 ~113 days

Total

5

Last Release

1889d ago

PHP version history (2 changes)0.1-betaPHP >=7.0

0.3.2PHP >=7.1

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/771368?v=4)[idoit](/maintainers/idoit)[@idoit](https://github.com/idoit)

---

Top Contributors

[![leonardfischer](https://avatars.githubusercontent.com/u/399835?v=4)](https://github.com/leonardfischer "leonardfischer (56 commits)")

---

Tags

apiZenkit

###  Code Quality

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/idoit-zenkit-api-client/health.svg)

```
[![Health](https://phpackages.com/badges/idoit-zenkit-api-client/health.svg)](https://phpackages.com/packages/idoit-zenkit-api-client)
```

###  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)[theodo-group/llphant

LLPhant is a library to help you build Generative AI applications.

1.5k311.5k5](/packages/theodo-group-llphant)[bushlanov-dev/max-bot-api-client-php

Max Bot API Client library

281.6k](/packages/bushlanov-dev-max-bot-api-client-php)

PHPackages © 2026

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