carehq/carehq-php

CareHQ API Client for PHP.

0.0.8 2024-03-08 13:14 UTC

Requires

• php: >=5.6.0
• ext-curl: *
• ext-json: *
• rmccue/requests: 2.0.10

MIT

• CRMHQ and contributors

• api
• carehq

README

CareHQ API Client for PHP.

Composer installation

You can install the bindings via Composer. Run the following command:

composer require CareHQ/carehq-php

To use the bindings, use Composer's autoload:

require_once('vendor/autoload.php');

Manual installation

If you do not wish to use Composer, you can download the latest release. Then, to use the bindings, include the init.php file.

require_once('/path/to/carehq-php/init.php');

Requirements

• PHP 5.6.0+

Usage

require_once('vendor/autoload.php');


$api_client = new CareHQ\APIClient(
    'MY_ACCOUNT_ID',
    'MY_API_KEY',
    'MY_API_SECRET'
);

$users = $api_client->request(
    'get',
    'users',
    [
        'attributes' => [
            'first_name',
            'last_name'
        ],
        'filters-q' => 'ant'
    ]
);