RoboHead uses REST APIs. The typical input is provided as input name-value pairs. For larger data, the input parameter can be JSON type. The response is almost always returned as JSON.

The most commonly used APIs are listed here for easy access. The Sample JSON response is also provided for each of these.

• Token based authentication -    Your account admin should be able generate the user token for you. This token will not expire automatically, but the account admin can regenerate (create a new token) if required. You should pass the token as a parameter name 'userApiToken' to every API request.

• Get all fields   Use this API to get the list of all fields for Project, Campaign and Request. You will have to collect all IDs returned by this API while adding or updating these objects.

• Get field options   Use this API to get the list of options (values) of the fields of type list (radio buttons, checkboxes, dropdowns) for Project, Campaign and Request.

• List active projects   The API to get all active projects.

• Get project details   The API to get specified project information.

• Add project   The API to add new project. The input parameter values are supplied as JSON. More information is provided in the API specifications.

• Update project   The API to update project. The input parameter values are supplied as JSON. More information is provided in the API specifications.

The documentation is divided into different functional modules as listed below. Clicking on the module or the specified link will take you to the documentation for that module.