Overview

Zoho People API

Zoho People provides API (Application Programming Interface) for integrating HR modules with third-party applications. With the Zoho People API, you can extract employees data and forms data in XML or JSON format and develop new applications or integrate with your existing business applications. As the Zoho People API is independent of programming languages, you can develop applications in any programming language (Java, .Net, C, C++, PHP, etc.)

 

 

Listed below are some of the things you can do with our API:-

• Add Employee from your website
• Add Department
• Add record to other predefined forms and custom forms
• Update record of any forms
• Fetch records of any form

What do I need to do before using your API?

To use our API you should have the following

• A valid Zoho People user name and password
• Internet connection to invoke Zoho People API

Authentication Token

To use the API, you will require Zoho People authentication token from your Zoho People account. If you face any difficulties in generating the authentication token, contact support@zohopeople.com

How do I generate Authtoken?

You can generate the authtoken in two ways:

1. Browser Mode
2. API Mode

Browser Mode

To generate the permanent authtoken, browse the following URL:

You will be requested to sign in, if you are not signed in already

Sample Response

Description of the Response

Parameter	Description
#Comment	Authtoken generated date.
AUTHTOKEN	The permanent authtoken generated for Zoho People API access.
RESULT	Value is TRUE if the authtoken is generated successfully.

API Mode

To generate the permanent authtoken, you need to submit an HTTP POST request to the following URL

The POST body should include a string in the following format

Mandatory fields to be passed in the URL are:

SCOPE	Zohopeople/peopleapi
EMAIL_ID	Your Zoho login name or email ID
PASSWORD	Password for the Zoho ID

Sample Response

Description of the Response

Parameter	Description
#Comment	Authtoken generated date.
AUTHTOKEN	Authtoken generated for the request.
RESULT	Value is TRUE if the authtoken is generated successfully.

Example

Here's an example for sample API call with Auth Token

Manage Auth Tokens

You can view, delete and regenerate the Auth Token generated for your account from 'My Zoho Account' Page.

1. Log in to Zoho People
2. Open [Username] > My Zoho Account
3. In My Zoho Account page, click Active Authtokens
   In this page, you can also remove or regenerate Auth Tokens.

Important Notes

• The Auth Token is user-specific and is a permanent token.
• On deletion, the existing token will be deleted permanently. The new token has to be replaced in all API calls.
• The Auth Token of a user's account will become invalid if the user is deactivated.

What is the mandatory parameters to be passed for all APIs?

The mandatory parameter for all API is "authtoken".