Fetch Components by ID API

This API is used to fetch a single component using a component ID.

Request URL:

https://people.zoho.com/api/compensation/v1/components/<componentID>

Header:

Authorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf

Request Method:

GET

Scope:

ZohoPeople.compensation.ALL

Request Parameters:

componentID:
(mandatory)

ID of the component to be fetched

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/components/138695000000333176

Sample Response:

Copied{
 "response": {
 "result": {
 "ctcComponents": [
 {
 "Payment_Type_Id": 1,
 "Payment_Frequency_Id": 1,
 "Description": "",
 "Part_Of_CTC": true,
 "Calculation_Type_Id": 1,
 "Calculation_Type": "Flat Amount",
 "Component_Category": "Earnings",
 "Payment_Type": "Fixed",
 "Component_Name": "trichyloc",
 "Payment_Frequency": "Monthly",
 "Component_Code": "trichyloc",
 "Component_Id": "148113000000376068",
 "Component_Category_Id": 1,
 "Location": [
 "148113000000376003"
 ]
 }
 ]
 },
 "message": "Success",
 "uri": "/api/compensation/v1/components/148113000000376068",
 "status": 0
 }
}