PHPackages                             circle-interactive/civicrm-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. circle-interactive/civicrm-api

ActiveLibrary

circle-interactive/civicrm-api
==============================

An API library to enable and facilitate interacting with a remote CiviCRM site.

v1.2.0(4y ago)2592[1 issues](https://github.com/circle-interactive/civicrm-api/issues)AGPL-3.0PHPPHP ^7.4 || ^8.0

Since Apr 4Pushed 4y ago2 watchersCompare

[ Source](https://github.com/circle-interactive/civicrm-api)[ Packagist](https://packagist.org/packages/circle-interactive/civicrm-api)[ Docs](https://www.github.com/circle-interactive/civicrm-api)[ RSS](/packages/circle-interactive-civicrm-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (10)Versions (4)Used By (0)

civicrm-api
===========

[](#civicrm-api)

civicrm-api is a Composer package that allows developers to interact with a [CiviCRM](https://civicrm.org) instance using the REST API v4 functionality within CiviCRM.

This code is intended to be used outside of a CiviCRM deployment environment. As such, the codebase adheres to PSR-12 coding standards instead of Drupal/Wordpress/CiviCRM coding standards.

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

[](#installation)

To install the library, run the following command:

`composer require circle-interactive/civicrm-api`

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

[](#requirements)

1. The CiviCRM server **must** be running on v5.47 or later.

In this release, the `/civicrm/ajax/*` endpoints were exposed as web services as part of currently ongoing efforts to expose REST endpoints via the standard CiviCRM routing system. [Click here to learn more](https://lab.civicrm.org/dev/core/-/issues/2077).

2. Your application **must** use an HTTP client that is [PSR-18](https://www.php-fig.org/psr/psr-18/) compliant.

If your application uses an HTTP client that is not compliant with [PSR-18](https://www.php-fig.org/psr/psr-18/), it will be necessary to write a decorator class that implements a `sendRequest` method.

How to Use
----------

[](#how-to-use)

*NB: As you can see from the examples, this library does not deserialize responses. This is by design.*

*Calling code is responsible for response deserialization and handling the data from that response.*

### Guzzle Example

[](#guzzle-example)

```