The CustomerHero API allows access to the resources of the customerhero.com website using a JSON interface. This makes it possible to create external applications that integrate with the Customerhero.com user account.


Service URL

The API access point (base URL) is located at:

https://www.customerhero.com/api/v2

Access is provided via an encrypted connection (https://).


How the CustomerHero API is organized


REST, REST-like

Operations in the CustomerHero API are organized according to the REST style. This means that the URL identifies a specific resource, while the action to be performed is determined based on the appropriate URL segments and the method (GET, POST).

  • GET – retrieving information about a resource or deleting a resource with the given identifier

  • POST – creating a new resource or modifying an existing one


Format of the returned response

The CustomerHero API returns responses in the – JSON format.


Encoding

All data sent to the CustomerHero API should be encoded in UTF-8.


Authentication

You can find the Key and API Secret in the Account Settings under the Integrations tab.

Additionally, you need to generate an access token to be able to connect to the API.


Status/error codes

The result of an executed request can be determined based on the HTTP error code.
The following codes are used in the CustomerHero API:

  • 200 OK – The request was executed successfully

  • 400 Bad Request – A parameter took an invalid value, or the parameter value is not within the specified set.

  • 401 Unauthorized – Lack of authorization or permissions for a given resource.

  • 402 Payment Required – The limitations of the purchased plan prevent access to the resource.

  • 404 Not Found – The resource was not found or does not exist.

  • 406 Not Acceptable – A required parameter was not passed.

  • 409 Conflict – Code returned upon an unsuccessful attempt to save data (e.g., survey activation).

  • 500 Internal Server Error – Code returned in case of an internal server error.