PHPackages                             firewards/convertkit-php-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. [Mail & Notifications](/categories/mail)
4. /
5. firewards/convertkit-php-api

ActiveLibrary[Mail & Notifications](/categories/mail)

firewards/convertkit-php-api
============================

Simple access interface to ConvertKit's web API.

1.0(6y ago)266[2 PRs](https://github.com/Firewards/convertkit-php-api/pulls)MITPHP

Since Jun 20Pushed 3y ago1 watchersCompare

[ Source](https://github.com/Firewards/convertkit-php-api)[ Packagist](https://packagist.org/packages/firewards/convertkit-php-api)[ RSS](/packages/firewards-convertkit-php-api/feed)WikiDiscussions master Synced today

READMEChangelog (1)Dependencies (1)Versions (4)Used By (0)

ConvertKit PHP
==============

[](#convertkit-php)

Unofficial ConvertKit PHP API for [v3](https://api.convertkit.com/v3/).

This package makes it simple to access ConvertKit's web API. Checkout  for more information on ConvertKit's API.

[![Source Code](https://camo.githubusercontent.com/85d3f76108995270815de71731fdf18d3c66f35f1dcc0bbf0dbdc6225fdd8f6e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736f757263652d636f6e766572746b69742d2d7068702d2d6170692d626c7565)](https://github.com/Firewards/convertkit-php-api)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](https://github.com/Firewards/convertkit-php-api/blob/master/LICENSE)

Install
-------

[](#install)

Via Composer

```
$ composer require firewards/convertkit-php-api
```

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

[](#requirements)

The following versions of PHP are supported.

- PHP 5.6
- PHP 7.0
- PHP 7.1
- PHP 7.2
- PHP 7.3

### API Key

[](#api-key)

All API calls require an API Key. You can find your API Key in the ConvertKit Account page.

### API Secret

[](#api-secret)

Some API calls require an API Secret. All calls that require the api key will also work with the api secret, there's no need to use both. This key grants access to sensitive data and actions on your subscribers.

Usage
-----

[](#usage)

Start by using ConvertKit API and creating an instance with your ConvertKit API key

```
$api = new \Firewards\Apis\ConvertKit($api_key, $api_secret);
```

### Examples

[](#examples)

**Get all Subscribers**

Get all subscribers using pagination.

```
$i = 0;
while ($subscribers = $api->getSubscribers($i++))
{
    if (!isset($subscribers->subscribers) || count($subscribers->subscribers) === 0)
    {
        break;
    }

    var_dump($subscribers);
}
```

**Get all Custom Fields**

```
$customFields = $api->getCustomFields();
```

**Create a Custom Field**

```
$lastNameField = $api->createCustomField('last_name');
```

**Update subscriber**

Updates a subscriber and adds info to a custom field 'last\_name'.

```
$subscriberId = '1234';
$lastNameField = $api->updateSubscriber($subscriberId, ['last_name' => 'Stücken']);
```

**Get Tags**

Retrieve all tags.

```
$tags = $api->getTags();
```

**Add Subscriber to Tag**

Adds a subscriber to a specific tag.

```
$added = $api->addSubscriberToTag($tagId, $email);
```

**Subscribe to a form**

Add a subscriber to a form. The `$subscribed` response will be an object.

```
$tag_id = '99999'; // This tag must be valid for your ConvertKit account.

$options = [
			'email'      => 'test@test.com',
			'name'       => 'Full Name',
			'first_name' => 'First Name',
			'tags'       => $tag_id,
			'fields'     => [
				'phone' => 134567891243,
				'shirt_size' => 'M',
				'website_url' => 'testurl.com'
			]
		];

$subscribed = $api->form_subscribe($this->test_form_id, $options);
```

**Get Subscriber ID**

Get the ConvertKit Subscriber ID for a given email address.

```
$subscriber_id = $api->get_subscriber_id( $email );
```

**Get Subscriber**

Get subscriber data for a ConvertKit Subscriber.

```
$subscriber = $api->get_subscriber( $subscriber_id );
```

**Get Subscriber Tags**

Get all tags applied to a Subscriber.

```
$subscriber_tags = $api->get_subscriber_tags( $subscriber_id );
```

**Add Tag to a Subscriber**

Apply a tag to a Subscriber.

```
$tag_id = '99999'; // This tag must be valid for your ConvertKit account.
$api->add_tag(tag_id, [
			'email' => 'test@test.com'
		]);
```

### Rate limiting

[](#rate-limiting)

Please note that ConvertKit is rate limiting requests by 120 requests per minute. If your request rate exceeds the limit, ConvertKit PHP Api will throw a *RateLimitExcededException*.

License
-------

[](#license)

The MIT License (MIT). Please see [License File](https://github.com/thephpleague/oauth2-client/blob/master/LICENSE) for more information.

Sponsor
-------

[](#sponsor)

This package is sponsored by [www.firewards.com](https://www.firewards.com), Firewards makes it easy to setup a referral and rewards program for your email list and newsletter.

###  Health Score

27

—

LowBetter than 47% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity58

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

Unknown

Total

1

Last Release

2204d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/954b10a1446b3623b01189c7e93ff3c8075222098c4a5116b4bbcb720b80cc16?d=identicon)[dstuecken](/maintainers/dstuecken)

---

Top Contributors

[![dstuecken](https://avatars.githubusercontent.com/u/493399?v=4)](https://github.com/dstuecken "dstuecken (2 commits)")

---

Tags

apiconvertkitemailfirewards

### Embed Badge

![Health badge](/badges/firewards-convertkit-php-api/health.svg)

```
[![Health](https://phpackages.com/badges/firewards-convertkit-php-api/health.svg)](https://phpackages.com/packages/firewards-convertkit-php-api)
```

###  Alternatives

[maize-tech/laravel-email-domain-rule

Laravel Email Domain Rule

612.0k](/packages/maize-tech-laravel-email-domain-rule)[sarfraznawaz2005/noty

Laravel package to incorporate noty flash notifications into laravel.

324.5k](/packages/sarfraznawaz2005-noty)

PHPackages © 2026

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