URL/URI Structure

The design of AnswerHub's REST API follows several guiding principles:

  • The base URL used to test out the API is https://apidocs.cloud.answerhub.com.
  • All request URIs must use the /services/v2/ prefix.
  • Operations requests to related, contained, or child nodes must also contain a prefix with the URI of the parent container node to successfully receive a response from the REST API.
  • URI/URL segments that identify the type of entity involved, use the uncapitalized, singular form name of that entity.
  • For example, if you wanted to get a list of users the URL would look like the following:
    https://apidocs.cloud.answerhub.com/services/v2/user.json