API Documentation

Authentication Before you can use any API functions, you need to authenticate a user. Description: Authenticate user. URL structure: https://your_subdomain.crm.me/crm/app/index.php/zurmo/api/login...

All API functions return data in the following format (after response if decoded): $response = array( 'status' => '', 'data' => array(), 'message' => '', 'errors' => array() ); sta...

Note: In all API calls, replace the % and example values between the % signs with your own variable values. Get Account Replace %id% with the id of the account that you want to retrieve, %sessionId...

Note: In all API calls, replace the % and example values between the % signs with your own variable values. Get Contact Replace %id% with the id of the contact that you want to retrieve, %sessionId...

Only difference between Contact and Lead models are state field, which determine if model is contact or lead. Leads API calls are very similar to contacts API calls, except that in API urls you ne...

Note: In all API calls, replace the % and example values between the % signs with your own variable values. Get Meeting Replace %id% with the id of the meeting that you want to retrieve, %sessionId...

Note: In all API calls, replace the values between % and % with your own variable values. Get Task Replace %id% with the id of the task that you want to retrieve, %sessionId% and %token% with ‘sess...

Note: In all API calls, replace the % and example values between the % signs with your own variable values. Get Opportunity Replace %id% with the id of the opportunity that you want to retrieve, %s...

Note: In all API calls, replace the % and example values between the % signs with your own variable values. Get CustomField Replace %customField% with the name of CustomField that you want to retri...

REST API code is flexible, and it allows you to write API methods for custom models that should be accessible via API. Yii is a free, open-source Web application development framework written in PH...

Note: In all API calls, replace the % and example values between the % signs with your own variable values. Get Note Replace %id% with the id of the note that you want to retrieve, %sessionId% and ...

Note: In all API calls, replace the % and example values between the % signs with your own variable values. Get User Replace %id% with the id of the user that you want to retrieve, %sessionId% and ...

Note: In all API calls, replace the % and example values between the % signs with your own variable values. Get Group Replace %id% with the id of the group that you want to retrieve, %sessionId% an...

Note: In all API calls, replace the % and example values between the % signs with your own variable values. Get Role Replace %id% with the id of the role that you want to retrieve, %sessionId% and ...

Note: In all API calls, replace the % and example values between the % signs with your own variable values. Get AccountAccountAffiliation Replace %id% with the id of the AccountAccountAffiliation t...

Note: In all API calls, replace the % and example values between the % signs with your own variable values. Get AccountContactAffiliation Replace %id% with the id of the AccountContactAffiliation t...

This is a PHP helper class that is used in all PHP samples in API specification, so you don’t have to repeat the code in all samples. Function ApiRestHelper::createApiCall($url, $method, $headers, ...

Note: In all API calls, replace the % and example values between the % signs with your own variable values. Get ContactState Replace %id% with the id of the contact state that you want to retrieve,...

You can change the language in which the data is returned via API. To change the API language, you need to pass a parameter with http headers ‘ZURMO_LANG’, and this parameter must contain the langu...

Note: In all API calls, replace the % and example values between the % signs with your own variable values. Get Currency Replace %id% with the id of the group that you want to retrieve, %sessionId%...