Open API Introduction

This is a documentation on the RESTFUL public API that the CRM system provides.

API Formatting

API HTTP Methods

HTTP method	CRUD	Action
GET	read	returns requested data
POST	create	creates a new record
PUT/PATCH	update	updates an existing record
DELETE	delete	deletes an existing record

Request Tips

• For all requests, an API Key will be required to authenticate requests of the public APIs. For more details on authentication please refer to this section.
• For GET and DELETE requests, there will not be any request body. Parameters are passed via query parameters.
• For POST/PUT/PATCH requests, request body will be JSON format. HTTP header should have Content-Type: application/json. Signature will be required if a request body is present. For more details on the signature please refer to this section.

API Response

All API will respond with a HTTP status code described below Successful Responses

HTTP Code	Description	Response Body
200	Successful API request	JSON body
201	Successful object creation	JSON body
204	Successful API request	No response

Failed Responses

HTTP Code	Description	Response Body
400	Application errors identified by type	{   "error": true,   "code": 400,   "type": "${type}" }
403	Access denied	{   "error": true,   "code": 403,   "type": "${type}" }
404	Resource not found	{   "error": true,   "code": 404,   "type": "resource_not_found" }