Search by

responsebee / api-client

official_maxwep

Official PHP client for the ResponseBee external API

v1.0.1 2026-08-09 07:52 UTC

This package is not auto-updated.

Last update: 2026-09-21 06:33:27 UTC


README

Official PHP client for the ResponseBee external API (forms + responses).

Install

composer require responsebee/api-client

Usage

require 'vendor/autoload.php';

use ResponseBee\Client;
use ResponseBee\Exception\ResponseBeeException;

$client = new Client(
    apiKey: 'rb_live_xxxxxxxxxxxxxxxx',
    baseUrl: 'https://app.yourdomain.com' // your ResponseBee app URL
);

try {
    // List forms
    $forms = $client->listForms();

    // Get one form
    $form = $client->getForm('form_123');

    // Create a form
    $newForm = $client->createForm([
        'name' => 'Contact Us',
        'description' => 'Simple contact form',
    ]);

    // Get a referral link with a tracking tag
    $link = $client->getReferralLink('form_123', 'newsletter');

    // Submit a response to a form
    $response = $client->createResponse('form_123', [
        'email' => 'user@example.com',
        'message' => 'Hello!',
    ]);

    // List responses across all forms
    $responses = $client->listResponses(['status' => 'valid']);

    // List responses for one form
    $formResponses = $client->listFormResponses('form_123');

} catch (ResponseBeeException $e) {
    echo 'Error: ' . $e->getMessage();
    // $e->getResponseBody() has the raw API error payload
}

Getting an API key

Generate an API key from your ResponseBee dashboard under API Keys. Your plan must have API access enabled.

License

MIT

responsebee-php-sdk