Fetch Settings API

This API is used to fetch the compensation service configuration details.

Request URL:

https://people.zoho.com/api/compensation/v1/settings

Header:

Authorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf

Request Method:

GET

Scope:

ZohoPeople.compensation.ALL

Threshold Limit: 300 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

Error Codes & Responses

Sample Request:

Copiedhttps://people.zoho.com/api/compensation/v1/settings

Sample Response:

Copied{
    "response": {
        "result": [
            {
                "isSalaryStructureEnabled": true
            }
        ],
        "message": "Success",
        "uri": "/api/compensation/v1/settings",
        "status": 0
    }
}