Introduction
The Zoho Shifts API allows you to programmatically access and manage employees, shifts, time off requests and timesheets.
Built using HTTP and REST principles which ensures predictable URLs that makes writing applications easy.
The Zoho Shifts API accepts and returns data in JSON format.
Base URL
All resource endpoints are relative to https://shifts.zoho.com/api/v1/{org_id}
. For example, the full URL of /employees
endpoint will be https://shifts.zoho.com/api/v1/{org_id}/employees
.
Host URL
Zoho Shifts is hosted at multiple data centers, and therefore host URL is different for each data center. You will have to use correct host URL of the data center in which you have account.
Data Center | Host URL |
---|---|
United States | https://shifts.zoho.com |
Europe | https://shifts.zoho.eu |
Australia | https://shifts.zoho.com.au |
Organization ID
In Zoho Shifts you can have multiple organization account based on your needs. Each organization has it's own organization ID, data (employees, shifts etc.,) and subscription. All resource endpoints will fetch data from one particular organization.
Replace {org_id}
in the base URL with correct organization ID.
The organization ID can be obtained from the GET /organizations
API.
The required OAuth scope is ZohoShifts.settings.READ
.
Alternatively you can find organization ID in Manage Organizations page in Zoho Shifts.
- Login to Zoho Shifts
- Click user profile icon at the top right corner
- Click Manage link in My Organizations
https://shifts.zoho.com/api/v1/{org_id}
$ curl https://shifts.zoho.com/api/v1/organizations
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"organizations": [
{
"name": "Zillum",
"created_at": "2022-04-30T12:57:22.543Z",
"id": "1234567",
"is_default": "false",
},
{
"name": "SBM",
"created_at": "2023-11-06T09:45:22.543Z",
"id": "2345678",
"is_default": "true",
}
]
}