Job Sites

Job sites in Zoho Shifts can be used to schedule your employees to work at locations away from your business location.

End Points

GET

/settings/jobsites

POST

/settings/jobsites

PUT

/settings/jobsites/{jobsite_id}

DELETE

/settings/jobsites/{jobsite_id}

Get all job sites

List all job sites in an organization.

Required OAuth Scope: ZohoShifts.settings.READ

Query Parameters

page

limit

$ curl https://shifts.zoho.com/api/v1/{org_id}/settings/jobsites
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

{
    "job_sites": [
        {
            "id": "714000000002029",
            "name": "North Plaza",
            "schedules": [
                {
                    "id": "714000000002029",
                    "name": "Midtown"
                }
            ],
            "address": "4141 Hacienda Drive, Pleasanton, CA 94588, USA",
            "latitude": "37.68592076576507",
            "longitude": "-121.89379414320189",
            "notes": "string"
        }
    ],
    "meta": {
        "count": 10,
        "limit": 50,
        "page": 1
    }
}

Create a job site

Required OAuth Scope: ZohoShifts.settings.CREATE

Arguments

name

string

(Required)

schedules

array

Show Sub-Attributes

string

address

string

latitude

string

longitude

string

notes

string

$ curl https://shifts.zoho.com/api/v1/{org_id}/settings/jobsites
-X POST
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'

{
    "name": "North Plaza",
    "schedules": [
        {
            "id": "714000000002029"
        }
    ],
    "address": "4141 Hacienda Drive, Pleasanton, CA 94588, USA",
    "latitude": "37.68592076576507",
    "longitude": "-121.89379414320189",
    "notes": "string"
}

{
    "id": "714000000002029",
    "name": "North Plaza",
    "schedules": [
        {
            "id": "714000000002029",
            "name": "Midtown"
        },
        {...},
        {...}
    ],
    "address": "4141 Hacienda Drive, Pleasanton, CA 94588, USA",
    "latitude": "37.68592076576507",
    "longitude": "-121.89379414320189",
    "notes": "string"
}

Update a job site

Required OAuth Scope: ZohoShifts.settings.UPDATE

Arguments

name

string

schedules

array

Show Sub-Attributes

string

address

string

latitude

string

longitude

string

notes

string

$ curl https://shifts.zoho.com/api/v1/{org_id}/settings/jobsites/{jobsite_id}
-X PUT
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'

{
    "name": "North Plaza",
    "schedules": [
        {
            "id": "714000000002029"
        }
    ],
    "address": "4141 Hacienda Drive, Pleasanton, CA 94588, USA",
    "latitude": "37.68592076576507",
    "longitude": "-121.89379414320189",
    "notes": "string"
}

{
    "id": "714000000002029",
    "name": "North Plaza",
    "schedules": [
        {
            "id": "714000000002029",
            "name": "Midtown"
        },
        {...},
        {...}
    ],
    "address": "4141 Hacienda Drive, Pleasanton, CA 94588, USA",
    "latitude": "37.68592076576507",
    "longitude": "-121.89379414320189",
    "notes": "string"
}

Delete a job site

Required OAuth Scope: ZohoShifts.settings.DELETE

$ curl https://shifts.zoho.com/api/v1/{org_id}/settings/jobsites/{jobsite_id}
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

{
    "message": "Job site deleted"
}