- Overview
- Authentication
- Organization
- API Limits
- Forms API
- Cases API
- Timesheet API
- Onboarding API
- Announcements API
- Leave API
- Attendance API
- Compensation API
- GETFetch Components API
- GETFetch Components by ID API
- GETFetch Salary Components API
- GETFetch Packages API
- GETFetch Package by ID API
- GETFetch Package Components API
- GETFetch Currencies API
- GETFetch Currency by ID
- GETFetch Revisions API
- GETFetch Revisions by ERECNO API
- GETFetch Revision Letters by ERECNO API
- GETPreview Revision Letter by Revision ID API
- GETDownload Revision Letter by Revision ID API
- GETFetch My Compensation API
- GETFetch Reasons API
- GETFetch Settings API
- PUTCancel Revision API
- GETFetch Salary API
- GETFetch Single Employee Salary API
- POSTAdd Salary API
- PUTUpdate Salary API
- Compensation API Error Codes
- Record Count API
- LMS API
- Courses API
- Pre Learning Activities API
- Post Learning Activities API
- Course Action API
- Course Learner API
- Batch API
- Batch Scheduler API
- Batch Action API
- Module API
- File API
- Content API
- Link API
- Session API
- Offline Test API
- Online Test API
- Assignment API
- Settings API
- Trainer API
- Rooms API
- Categories API
- LMS Api Error Codes
- Files API
- View API
- Standalone Function
- Status Codes
- Error Codes API
- HTTP Request Methods
Fetch Packages API
This API is used to fetch all the salary packages.
Request URL:
https://people.zoho.com/api/compensation/v1/packages
Header:
Authorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf
Request Method:
GET
Scope:
ZohoPeople.compensation.ALL
Request Parameters:
locationIds: | Location ID to fetch packages applicable to that location example:["148113000000376003"] |
designationIds: | Designation ID to fetch packages applicable to that designation example:["148113000000376003"] |
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.
Sample Request:
Copiedhttps://people.zoho.com/api/compensation/v1/packages
Sample Response:
Copied{
"response": {
"result": [
{
"Description": "Entry Level",
"Package_Id": "148113000000342707",
"Is_Default": true,
"Formatted_CTC": "AED 0.00",
"Currency_Id": "148113000000342626",
"Modified_By": "1 - Mrunal Thakur",
"CTC": "0.00",
"Exchange_Rate": "1",
"Applicability": {
"BUSINESSUNIT": [
"-1"
],
"LOCATION": [
"-1"
],
"DESIGNATION": [
"-1"
],
"STREAM": [
"-1"
],
"EXPERIENCE": "0 Year from Date of joining",
"LEVEL": [
"-1"
],
"LEGALENTITY": [
"-1"
],
"DIVISION": [
"-1"
]
},
"Created_By": "1 - Mrunal Thakur",
"Currency_Code": "AED",
"Modified_Date": "06-Aug-2024 10:43:57 AM",
"Package_Name": "Entry Level",
"Created_Date": "06-Aug-2024 10:43:57 AM"
},
{
"Description": "chennaipack",
"Package_Id": "148113000000376130",
"Is_Default": false,
"Formatted_CTC": "AED 90000.00",
"Currency_Id": "148113000000342626",
"Modified_By": "1 - Mrunal Thakur",
"CTC": "90000.00",
"Exchange_Rate": "1",
"Applicability": {
"BUSINESSUNIT": [
"-1"
],
"LOCATION": [
"148113000000376013"
],
"DESIGNATION": [
"-1"
],
"STREAM": [
"-1"
],
"EXPERIENCE": "0 Year from Date of joining",
"LEVEL": [
"-1"
],
"LEGALENTITY": [
"-1"
],
"DIVISION": [
"-1"
]
},
"Created_By": "1 - Mrunal Thakur",
"Currency_Code": "AED",
"Modified_Date": "20-Aug-2024 03:02:40 PM",
"Package_Name": "chennaipack",
"Created_Date": "20-Aug-2024 03:02:08 PM"
}
],
"message": "Success",
"uri": "/api/compensation/v1/packages",
"status": 0
}
}
Show full
Show less
© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.