Users
Overview
A user is someone who has access to an organization in Bigin. Users can become part of one or more organizations in a Bigin account. Every user in an organization is assigned with a role and an appropriate profile. Users of an organization can create and manage records, send emails, log calls and so on. For more information, see about user management.
Endpoints
Get users data
Retrieves the list of available users in an organization, and fetch a specific user with user ID.
Request URL
For all users, use
{api-domain}/bigin/v2/users
For a specific user, use
{api-domain}/bigin/v2/users/{user_id}
Choose domain-specific URL to replace {api-domain}
You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:
- For US, https://www.zohoapis.com
- For EU, https://www.zohoapis.eu
- For AU, https://www.zohoapis.com.au
- For IN, https://www.zohoapis.in
- For CN, https://www.zohoapis.com.cn
- For JP, https://www.zohoapis.jp
For more information, see Multi DC Support.
Authorization
For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.
Authorization: Zoho-oauthtoken <ACCESS_TOKEN>
You must authenticate using an access token that is associated with one of the following scopes:
- ZohoBigin.users.ALL
- ZohoBigin.users.READ
Request parameters
The available request parameters are given below:
Query parameters
type stringOptional
The type of users you want to retrieve. The type values include:
| Value | Description |
|---|---|
| AllUsers | Lists all users including active and inactive users in an organization. |
| ActiveUsers | Lists users who are active in an organization. |
| DeactiveUsers | Lists users who are not active in an organization. |
| ConfirmedUsers | Lists all confirmed users. |
| NotConfirmedUsers | Lists all non-confirmed users. |
| DeletedUsers | Lists the deleted users in an organization. |
| ActiveConfirmedUsers | Lists users who are active as well as confirmed. |
| AdminUsers | Lists the admin users. |
| ActiveConfirmedAdmins | Lists users who are active and confirmed with admin permissions. |
| CurrentUser | Lists the current Bigin user. |
page integerOptional
Represents the page index. This parameter lists the user records from the given page index. The default value is 1.
per_page integerOptional
Represents the number of user records per page index. The default value is 200, which means up to 200 user records can be retrieved per page index.
Notes:
The page and per_page parameters are utilized when you want to fetch more than 200 user records. Since the maximum number of user records per API call is 200, fetching records beyond the 200th position is not possible in a single call.However, by making two API calls with page values of 1 and 2 and a per_page value of 200, all 400 user records can be retrieved.
Sample request
Copiedcurl "https://www.zohoapis.com/bigin/v2/users?type=AllUsers" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2/users"
type: GET
connection:"connection_link_name"
];
info response;Response object
The response object contains the following details:
country, city, street, state, country_locale, zip string
Indicates the address of the user.
- country - The country of the user.
- city - The city where the user is located.
- street - The street address of the user.
- state - The state or province where the user is located.
- country_locale - The locale specific to the country of the user.
- zip - The ZIP or postal code of the user.
role jsonobject
Contains the details of user's role.
customize_info jsonobject
Contains the customization details about the user.
signature string
Indicates the signature of the user.
sort_order_preference string
Indicates the preferred sorting order for the user.
name_format string
Indicates the format of the user's name.
language string
Indicates the preffered language of the user.
microsoft boolean
Indicates if the user is associated with Microsoft.
locale string
Indicates the locale or region setting of the user.
personal_account boolean
Indicates if the user's account is personal.
Isonline boolean
Indicates if the user is currently online.
default_tab_group string
The default tab group for the user.
Modified_By jsonobject
Contains the details about the user who last modified this user's record.
$shift_effective_from string
The effective date of the user's shift.
$current_shift string
The details about the user's current shift.
alias string
The alias of the user.
theme jsonobject
The details about the user's theme.
id string
The unique identification (user ID) of the user.
fax, email, mobile, phonestring
Indicates the contact information of the user.
- fax - The fax details of the user.
- email - The email address of the user.
- mobile - The mobile number of the user.
- phone - The phone number of the user.
sandboxDeveloper boolean
Indicates if the user is a sandbox developer.
first_name string
The first name of the user.
decimal_separator string
The decimal separator used in numerical values.
created_time datetime
Indicates the date and time (ISO8601) when the user was created.
website string
The website associated with the user.
Modified_Time datetime
Indicates the date and time (ISO8601) of the most recent modifications performed for this user properties.
time_format string
The preferred time format for the user.
$next_shift string
The details about the user's next shift.
offset integer
The time zone offset for the user.
profile jsonobject
Contains the details about the user's profile.
last_name string
The last name of the user.
time_zone string
The time zone setting of the user.
number_separator string
The separator used for numbers.
created_by jsonobject
Contains the details about the user who created this user's record.
zuid string
The zuid (Zoho user ID) of the user.
confirm boolean
Indicates whether the user's account is confirmed or not.
full_name string
The full name of the user.
dob string
The date of birth of the user.
date_format string
The preferred date format for the user.
category string
The category to which the user belongs.
status string
The status of the user.
Possible error codes
The response of this resource includes HTTP status and error codes.
Sample response
Copied{
"users": [
{
"country": null,
"role": {
"name": "CEO",
"id": "2034020000000015966"
},
"customize_info": {
"notes_desc": null,
"show_right_panel": null,
"bc_view": null,
"show_home": false,
"show_detail_view": true,
"unpin_recent_item": null
},
"city": null,
"signature": null,
"sort_order_preference": "First Name,Last Name",
"name_format": "Salutation,First Name,Last Name",
"language": "en_US",
"microsoft": false,
"locale": "en_US",
"personal_account": false,
"Isonline": false,
"default_tab_group": "0",
"Modified_By": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"$shift_effective_from": null,
"street": null,
"$current_shift": null,
"alias": null,
"theme": {
"normal_tab": {
"font_color": "#FFFFFF",
"background": "#222222"
},
"selected_tab": {
"font_color": "#FFFFFF",
"background": "#222222"
},
"new_background": null,
"background": "#F3F0EB",
"screen": "fixed",
"type": "default"
},
"id": "2034020000000457001",
"state": "Reserved/Private",
"fax": null,
"country_locale": "en_US",
"sandboxDeveloper": false,
"first_name": "Zylker",
"email": "aravind.vavilala+travel_agency@zohotest.com",
"zip": null,
"decimal_separator": "Period",
"created_time": "2023-04-11T17:00:20+05:30",
"website": null,
"Modified_Time": "2023-04-11T17:01:35+05:30",
"time_format": "hh:mm a",
"$next_shift": null,
"offset": 19800000,
"profile": {
"name": "Administrator",
"id": "2034020000000015972"
},
"mobile": null,
"last_name": "Travels",
"time_zone": "Asia/Kolkata",
"number_separator": "Comma",
"created_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"zuid": "75407535",
"confirm": true,
"full_name": "Zylker Travels",
"phone": null,
"dob": null,
"date_format": "MMM d, yyyy",
"category": "regular_user",
"status": "active"
},
{
"country": null,
"role": {
"name": "Sales Manager",
"id": "2034020000000015969"
},
"city": null,
"sort_order_preference": "null",
"language": "en_US",
"locale": "en_US",
"microsoft": false,
"Isonline": false,
"Modified_By": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"$shift_effective_from": null,
"street": null,
"$current_shift": null,
"alias": null,
"id": "2034020000000472062",
"state": null,
"fax": null,
"country_locale": "en_US",
"sandboxDeveloper": false,
"first_name": "John",
"email": "aravjourney+johnsmith@gmail.com",
"zip": null,
"decimal_separator": "Period",
"created_time": "2023-04-17T16:10:02+05:30",
"website": null,
"Modified_Time": "2023-04-17T16:19:24+05:30",
"time_format": "hh:mm a",
"$next_shift": null,
"offset": 19800000,
"profile": {
"name": "Administrator",
"id": "2034020000000015972"
},
"mobile": null,
"last_name": "Smith",
"time_zone": "Asia/Kolkata",
"number_separator": "Comma",
"created_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"zuid": null,
"confirm": false,
"full_name": "John Smith",
"phone": null,
"dob": null,
"date_format": "MMM d, yyyy",
"category": "regular_user",
"status": "deleted"
},
{
"country": null,
"role": {
"name": "Sales Team Lead",
"id": "2034020000000472039"
},
"city": null,
"sort_order_preference": "null",
"language": "en_US",
"locale": "en_US",
"microsoft": false,
"Isonline": false,
"Modified_By": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"$shift_effective_from": null,
"street": null,
"$current_shift": null,
"alias": null,
"id": "2034020000000472081",
"state": null,
"fax": null,
"country_locale": "en_US",
"sandboxDeveloper": false,
"first_name": "Jan",
"email": "favag97277@ippals.com",
"zip": null,
"decimal_separator": "Period",
"created_time": "2023-04-17T16:17:51+05:30",
"website": null,
"Modified_Time": "2023-04-17T16:19:09+05:30",
"time_format": "hh:mm a",
"$next_shift": null,
"offset": 19800000,
"profile": {
"name": "Standard",
"id": "2034020000000015975"
},
"mobile": null,
"last_name": "Doe",
"time_zone": "Asia/Kolkata",
"number_separator": "Comma",
"created_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"zuid": null,
"confirm": false,
"full_name": "Jan Doe",
"phone": null,
"dob": null,
"date_format": "MMM d, yyyy",
"category": "regular_user",
"status": "deleted"
},
{
"country": null,
"role": {
"name": "Sales Manager",
"id": "2034020000000015969"
},
"city": null,
"sort_order_preference": "null",
"language": "en_US",
"locale": "en_US",
"microsoft": false,
"Isonline": false,
"Modified_By": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"$shift_effective_from": null,
"street": null,
"$current_shift": null,
"alias": null,
"id": "2034020000000472114",
"state": null,
"fax": null,
"country_locale": "en_US",
"sandboxDeveloper": false,
"first_name": "John",
"email": "aravind.vavilala+johnsmith@zohotest.com",
"zip": null,
"decimal_separator": "Period",
"created_time": "2023-04-17T16:23:53+05:30",
"website": null,
"Modified_Time": "2023-04-18T12:52:44+05:30",
"time_format": "hh:mm a",
"$next_shift": null,
"offset": 19800000,
"profile": {
"name": "Administrator",
"id": "2034020000000015972"
},
"mobile": null,
"last_name": "Smith",
"time_zone": "Asia/Kolkata",
"number_separator": "Comma",
"created_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"zuid": "75501536",
"confirm": true,
"full_name": "John Smith",
"phone": "+1-202-555-0178",
"dob": "1987-12-18",
"date_format": "MMM d, yyyy",
"category": "regular_user",
"status": "active"
},
{
"country": null,
"role": {
"name": "Sales Team Lead",
"id": "2034020000000472039"
},
"city": null,
"sort_order_preference": "null",
"language": "en_US",
"locale": "en_US",
"microsoft": false,
"Isonline": false,
"Modified_By": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"$shift_effective_from": null,
"street": null,
"$current_shift": null,
"alias": null,
"id": "2034020000000473008",
"state": null,
"fax": null,
"country_locale": "en_US",
"sandboxDeveloper": false,
"first_name": "Jane",
"email": "aravind.vavilala+janedoe@zohotest.com",
"zip": null,
"decimal_separator": "Period",
"created_time": "2023-04-17T16:47:31+05:30",
"website": null,
"Modified_Time": "2023-04-17T16:47:31+05:30",
"time_format": "hh:mm a",
"$next_shift": null,
"offset": 19800000,
"profile": {
"name": "Standard",
"id": "2034020000000015975"
},
"mobile": null,
"last_name": "Doe",
"time_zone": "Asia/Kolkata",
"number_separator": "Comma",
"created_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"zuid": null,
"confirm": false,
"full_name": "Jane Doe",
"phone": null,
"dob": null,
"date_format": "MMM d, yyyy",
"category": "regular_user",
"status": "active"
},
{
"country": null,
"role": {
"name": "Marketing Manager",
"id": "2034020000000472026"
},
"city": null,
"sort_order_preference": "null",
"language": "en_US",
"locale": "en_US",
"microsoft": false,
"Isonline": false,
"Modified_By": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"$shift_effective_from": null,
"street": null,
"$current_shift": null,
"alias": null,
"id": "2034020000000474009",
"state": null,
"fax": null,
"country_locale": "en_US",
"sandboxDeveloper": false,
"first_name": "Michael",
"email": "aravind.vavilala+michaelbrown@zohotest.com",
"zip": null,
"decimal_separator": "Period",
"created_time": "2023-04-18T11:46:59+05:30",
"website": null,
"Modified_Time": "2023-04-18T14:53:16+05:30",
"time_format": "HH:mm",
"$next_shift": null,
"offset": 19800000,
"profile": {
"name": "Administrator",
"id": "2034020000000015972"
},
"mobile": null,
"last_name": "Brown",
"time_zone": "Asia/Kolkata",
"number_separator": "Comma",
"created_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"zuid": null,
"confirm": true,
"full_name": "Michael Brown",
"phone": "+1-202-555-0119",
"dob": "1990-07-28",
"date_format": "MMM d, yyyy",
"category": "regular_user",
"status": "deleted"
},
{
"country": null,
"role": {
"name": "Sales Team Lead",
"id": "2034020000000472039"
},
"city": null,
"sort_order_preference": "null",
"language": "en_US",
"locale": "en_US",
"microsoft": false,
"Isonline": false,
"Modified_By": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"$shift_effective_from": null,
"street": null,
"$current_shift": null,
"alias": null,
"id": "2034020000000474061",
"state": null,
"fax": null,
"country_locale": "en_US",
"sandboxDeveloper": false,
"first_name": "Sarah",
"email": "aravind.vavilala+sarahjohnson@zohotest.com",
"zip": null,
"decimal_separator": "Period",
"created_time": "2023-04-18T11:54:34+05:30",
"website": null,
"Modified_Time": "2023-04-18T14:41:41+05:30",
"time_format": "HH:mm",
"$next_shift": null,
"offset": 19800000,
"profile": {
"name": "Standard",
"id": "2034020000000015975"
},
"mobile": null,
"last_name": "Johnson",
"time_zone": "Asia/Kolkata",
"number_separator": "Comma",
"created_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"zuid": "75520165",
"confirm": true,
"full_name": "Sarah Johnson",
"phone": "+1-202-555-0124",
"dob": "1989-10-30",
"date_format": "MMM d, yyyy",
"category": "regular_user",
"status": "active"
}
],
"info": {
"per_page": 200,
"count": 7,
"page": 1,
"more_records": false
}
}