1. Help Center
  2. HR Cloud API
  3. Authorization and Authentication

Documentation Conventions

This article lists the conventions used throughout the documentation.

The API documentation uses the following conventions:

  • A colon ( : ) indicates a replaceable parameter.

    For example, if the documentation shows 

    GET /xDepartment/:departmentid

    replace :departmentid with an actual department ID while creating actual URI as shown below:


    GET /xDepartment/27784c8a0686092e
  • Ellipses ( . . . ) indicate that the response data has been truncated. Instead of showing all records returned by a GET request, only some are shown, and the ellipses mark where additional records would be located.