This documentation refers to CiviCRM 3.2, current stable version. Please introduce all the documentation changes here.

CiviCRM Public APIs

This page refers to CiviCRM 3.2.

Documentation Search

CiviCRM 3.2 Documentation

Support and Participation

Developer Resources

CiviCRM book!
Make sure to check out Understanding CiviCRM as well! You can also support this project by ordering a hard copy.

Document Rev 2.0 - 8/11/2008
Each call has an availability status indicating the release when it was implemented (or NOT YET IMPLEMENTED). Also, the "return_properties" functionality is NOT supported for any of the API's unless explicitly noted. We will add support for this feature on an as-needed basis in upcoming releases.

They are 5 different way of using the APIs:

  1. as php function, for running your own code on the same server than the civicrm install
  2. via the REST interface, can be called from another server via http calls
  3. via the AJAX interface, to be called from javascript code
  4. as [smarty function] to add more variable not available by default in the template
  5. using the CiviCRM drush module (in Drupal)

Most of the examples and API descriptions are using the syntax for the 1. (direct php call). However, all these APIs can be acessed via the other channels as well, provided you adapt the syntax (eg. the list of return variables is either a php array, several get parameters or a comma separated list).

API Overview

Scope and Definitions, Permissioning, Remote Invocation, Error Handling...

Using CiviCRM APIs - Code Snippets

Collection of code snippets which demonstrate use of CiviCRM APIs

Changes in CiviCRM 2

What's new in CiviCRM 2

Contact and Contact Search APIs

Create, update, find and delete contacts...

Contribution APIs

Create, update, get and delete CiviContribute contribution records...

Group APIs

Create groups, get members of groups, add and remove group members...

Activity APIs

Create, update, delete and get Activities

Location APIs

Relationship APIs

Create, retrieve supported relationship types (spouse, employer, etc.). Create, get, delete relationships between contacts (individuals, households and/or organizations...

Custom Data Group and Custom Field APIs

Create and / or delete custom data groups and fields...

Note APIs

Create, update, get and delete Notes...

Tagging APIs

Create and delete tags. Assign tags to contacts, remove tags from contacts...

File APIs

Create files. Assign files to contacts...

Profile APIs

Definition of the User Profile Group of the CRM API.

Membership APIs

Assign or remove Memberships for Contacts, manage Membership Types, Membership Statuses

Event APIs

Create, update, get and delete Events...

Participant and Participant Payment APIs

Create ,update ,get and delete Participant and Participant Payment

Upgrading api's from v1 to v2

Naming Convention:: Upgrading from V1 to V2
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Creative Commons License
Except where otherwise noted, content on this site is licensed under a Creative Commons Attribution-Share Alike 3.0 United States Licence.