Logo
Submit a request Sign in

Get help by searching for solutions.

Type something you're looking for and press enter.

  1. CRM.me
  2. API Documentation

API Documentation

Follow New articles New articles and comments

  • REST API Specification – Authentication

    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...

  • REST API Specification – Response

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

  • REST API Specification – Accounts

    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...

  • REST API Specification – Contacts

    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...

  • REST API Specification – Leads

    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...

  • REST API Specification – Meetings

    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...

  • REST API Specification – Tasks

    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...

  • REST API Specification – Opportunities

    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...

  • REST API Specification – Custom Field

    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 Specification – Custom Models

    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...

  • REST API Specification – Notes

    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 ...

  • REST API Specification – Users

    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 ...

  • REST API Specification – Groups

    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...

  • REST API Specification – Roles

    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 ...

  • REST API Specification – Account-Account-Affiliation

    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...

  • REST API Specification – Account-Contact-Affiliation

    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...

  • REST API Specification – ApiRestHelper class

    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, ...

  • REST API Specification – ContactState

    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,...

  • REST API Specification – Change Language

    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...

  • REST API Specification – Currencies

    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%...

Powered by Zendesk