Records

Overview

A record stores information about individual entities, such as a user, product, company, or activity. It holds the combined data of an entity obtained from diverse sources like web-forms, social media services, and advertisements. By storing and organizing this information, records provide a comprehensive overview of the entity's details and activities.

Endpoints

Get records

Retrieves the list of available records in a module, and fetch a specific record in a module using record ID.

Request URL

For all records, use

{api-domain}/bigin/v2/{module_api_name}

For a specific record, use

{api-domain}/bigin/v2/{module_api_name}/{record_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.modules.ALL
  • ZohoBigin.modules.{module_name}.ALL
  • ZohoBigin.modules.{module_name}.READ

In the above scope, replace {module_name} with the module for which you want to retrieve the records. The possible modules include contacts, accounts (companies in Bigin), products, calls, events, and tasks.

Request parameters

The available request parameters are given below:

Path parameters

module_api_name stringRequired

The API name of the module. The possible modules for this endpoint and their API name are given below:

Module

API Name

Contacts

Contacts

Pipelines

Pipelines

Companies

Accounts

Products

Products

Tasks

Tasks

Events

Events

Calls

Calls

 

Query parameters

fields stringRequired

Specify the fields you want to retrieve in the API response. It accepts multiple field API names separated by commas. You can get the field API names from the Fields Metadata API by accessing the api_name value for each field. For example, if you want to fetch module records and include fields like Last_Name and Email, you can pass them as fields=Last_Name,Email.

You can pass up to 50 fields.

sort_order stringOptional

Specify the sorting order for list of records. It can be asc for ascending order or desc for descending order.

sort_by stringOptional

Specify the field API name based on which the records will be sorted. You can get the field API names from the Fields Metadata API by accessing the api_name value for each field. For example, to sort by email, set sort_by to Email.

approved stringOptional

Retrieve the list of records based on their approval status. The default value is true. You can set it to false to get records that are not approved or both to get all records regardless of approval status.

page integerOptional

Represents the page index. This parameter lists the records from the given page index. The default value is 1.

per_page integerOptional

Represents the number of records per page index. The default value is 200, which means up to 200 records can be retrieved per page index.

cvid stringOptional

Retrieve the list of records from a custom view using custom view ID (cvid). You can get the cvid from the Custom Views Metadata API.

Notes:

  • The sort_order parameter is applied based on the provided sort_by parameter value. If no sort_by field is provided, it will instead apply to the system-defined field.
  • The page and per_page parameters are utilized when you want to fetch more than 200 records. Since the maximum number of 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 records can be retrieved.

Sample request

CurlDeluge
Copiedcurl "https://www.zohoapis.com/bigin/v2/Contacts?fields=Last_Name,Email&per_page=3" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts?fields=Last_Name,Email&per_page=3"
	type: GET
	connection:"connection_link_name"
];
info response;

Response object

The response object contains a list of records in a specified module, filtered based on the query parameters provided.

Possible error codes

The response of this resource includes HTTP status and error codes.

The most common HTTP error codes that occur when you request access to this endpoint are given in the following:

 
  • INVALID_MODULEHTTP 400

    The module name given seems to be invalid
    Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.

  • INVALID_MODULEHTTP 400

    The given module is not supported in API
    Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.

  • NOT_SUPPORTEDHTTP 403

    This API is supported only for admin users
    Resolution: Only admin users can fetch records from the Notes module.

     

Sample response

Copied{
    "data": [
        {
            "Email": "james.bennett@example.com",
            "Last_Name": "Bennett",
            "id": "2034020000000489034"
        },
        {
            "Email": "ava.bell@example.com",
            "Last_Name": "Bell",
            "id": "2034020000000489033"
        },
        {
            "Email": "sophia.brooks@example.com",
            "Last_Name": "Brooks",
            "id": "2034020000000489022"
        }
    ],
    "info": {
        "per_page": 3,
        "next_page_token": "cd2cb80b7af0973c8e008732162ad76531368c7767801cf9a7b9326fdd5578a728bbac115d861df02b4a4b60bfe06182189add230965a0ed5a925bc4e680e765ebeb29025a542b7b46921c58c1b64ebd02f5ffc305eb68d9857d0c63cfb36a9fce7fc14570e8b40aa9374454b45fc32e8e141dee609b2c88d84bb9c590c93e1c",
        "count": 3,
        "sort_by": "id",
        "page": 1,
        "previous_page_token": null,
        "page_token_expiry": "2023-06-24T14:53:20+05:30",
        "sort_order": "desc",
        "more_records": true
    }
}

Get details of a contact

Retrieves details about a specific contact.

Request URL

{api-domain}/bigin/v2/Contacts/{record_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.modules.ALL
  • ZohoBigin.modules.contacts.ALL
  • ZohoBigin.modules.contacts.READ

Request parameters

The available request parameters are given below:

Path parameters

record_id stringRequired

The unique identification (record ID) of a contact. You can get the record ID from the Get records API.

Sample request

CurlDeluge
Copiedcurl "https://www.zohoapis.com/bigin/v2/Contacts/2034020000000489022" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts/2034020000000489022"
	type: GET
	connection:"connection_link_name"
];
info response;

Response object

The response object contains the following details:

Owner jsonobject

Indicates the owner details of the contact record.

Email, Phone, Mobile, Home_Phone string

Contact details:

  • Email - The email address associated with the contact.
  • Phone - The phone number associated with the contact.
  • Mobile - The mobile number of the contact.
  • Home_Phone - The home phone number of the contact.

 

Description string

The description about the contact record.

$currency_symbol string

A special field indicates the currency symbol associated with the contact record.

Mailing_Street, Mailing_City, Mailing_Zip, Mailing_State, Mailing_Country string

Indicates the mailing address of the contact. The mailing address contains the following fields:

  • Mailing_Street - The street address of the contact.
  • Mailing_City - The city where the contact is located.
  • Mailing_State - The state or province where the contact is located.
  • Mailing_Country - The country of the contact.
  • Mailing_Zip - The ZIP or postal code of the contact.
$field_states string

A special field indicates the states of certain fields in the contact record.

$followers string

A special field indicates the followers of the contact record.

$sharing_permission string

A special field indicates the level of sharing permission.

Last_Activity_Time datetime

The date and time of the last activity associated with the contact record.

First_Name string

The first name of the contact record.

Full_Name string

The full name of the contact.

Record_Image string

An image associated with the contact record.

Modified_By jsonobject

Indicates the user details who have performed the most recent modifications to the contact record.

Unsubscribed_Mode string

Indicates the unsubscription mode details of the contact.

Account_Name jsonobject

The company details are associated with the contact record.

id string

The unique identification of the contact record.

Email_Opt_Out boolean

Indicates whether the email address has opted out of communication.

$zia_visions string

Indicates the details about Zoho Intelligent Assistant (Zia).

Modified_Time datetime

The date and time of the last modification of the contact record.

Created_Time datetime

The date and time of when the contact record was created.

Unsubscribed_Time datetime

The date and time when the contact is unsubscribed.

$followed boolean

A special field indicates whether the contact record is followed or not.

Title string

The title of the contact.

$editable boolean

A special field indicates whether the contact record is editable or not.

Last_Name string

The last name of the contact.

Tag jsonarray

Lists the tags associated with the contact record.

Created_By jsonobject

Indicates the user details who have created the contact record.

$zia_owner_assignment string

Indicates the details of Zia's owner assignment.

$approval_state string

A special field indicates whether the contact record is approved or unapproved.

Sample response

Copied{
    "data": [
        {
            "Owner": {
                "name": "Sarah Johnson",
                "id": "2034020000000474061",
                "email": "sarah.johnson@example.com"
            },
            "Email": "sophia.brooks@example.com",
            "Description": "A sample description.",
            "$currency_symbol": "$",
            "Mailing_Zip": "92101",
            "$field_states": null,
            "Mailing_State": "CA",
            "Mailing_Street": "135 Walnut Dr.",
            "$followers": null,
            "$sharing_permission": "full_access",
            "Last_Activity_Time": "2023-05-26T12:29:51+05:30",
            "First_Name": "Sophia",
            "Full_Name": "Sophia Brooks",
            "Record_Image": null,
            "Modified_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "Unsubscribed_Mode": null,
            "Phone": null,
            "Mailing_Country": "Spain",
            "Account_Name": {
                "name": "Apex Enterprises",
                "id": "2034020000000478021"
            },
            "id": "2034020000000489022",
            "Email_Opt_Out": false,
            "$zia_visions": null,
            "Modified_Time": "2023-05-26T12:29:51+05:30",
            "Mailing_City": "San Diego",
            "Created_Time": "2023-04-20T17:13:47+05:30",
            "Unsubscribed_Time": null,
            "$followed": false,
            "Title": null,
            "$editable": true,
            "Mobile": "609-961-5520",
            "Home_Phone": null,
            "Last_Name": "Brooks",
            "Tag": [],
            "Created_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "$zia_owner_assignment": "owner_recommendation_unavailable",
            "$approval_state": "approved"
        }
    ]
}

Get details of a company

Retrieves details about a specific company.

Request URL

{api-domain}/bigin/v2/Accounts/{record_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.modules.ALL
  • ZohoBigin.modules.accounts.ALL
  • ZohoBigin.modules.accounts.READ

Request parameters

The available request parameters are given below:

Path parameters

record_id stringRequired

The unique identification (record ID) of a company. You can get the record ID from the Get records API.

Sample request

CurlDeluge
Copiedcurl "https://www.zohoapis.com/bigin/v2/Accounts/2034020000000489159" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/bigin/v2/Accounts/2034020000000489159"
type: GET
connection:"connection_link_name"
];
info response;

Response object

The response object contains the following details:

Owner jsonobject

Indicates the owner details of the company record.

Description string

The description about the company record.

$currency_symbol string

A special field indicates the currency symbol associated with the company record.

$field_states string

A special field indicates the states of certain fields in the company record.

Website string

The official website URL of the company record.

$followers string

A special field indicates the followers of the company record.

$sharing_permission string

A special field indicates the level of sharing permission.

Last_Activity_Time datetime

The date and time of the last activity associated with the company record.

Record_Image string

An image associated with the company record.

Modified_By jsonobject

Indicates the user details who have performed the most recent modifications to the company record.

Phone string

The phone number of the company record.

Billing_Country, Billing_Street, Billing_Code, Billing_City, Billing_State string

Indicates the billing address of the company. The billing address contains the following fields:

  • Billing_Street - The street address of the company.
  • Billing_City - The city where the company is located.
  • Billing_State - The state or province where the company is located.
  • Billing_Country - The country of the company.
  • Billing_code - The ZIP or postal code of the company.
Account_Name string

Indicates the name of the company.

id string

The unique identification of the company record.

$zia_visions string

Indicates the details about Zoho Intelligent Assistant (Zia).

Modified_Time datetime

The date and time of the last modification of the company record.

Created_Time datetime

The date and time of when the company record was created.

$followed boolean

A special field indicates whether the company record is followed or not.

$editable boolean

A special field indicates whether the company record is editable or not.

Tag jsonarray

Lists the tags associated with the company record.

Created_By jsonobject

Indicates the user details who have created the company record.

$zia_owner_assignment string

Indicates the details of Zia's owner assignment.

$approval_state string

A special field indicates whether the company record is approved or unapproved.

Sample response

Copied{
    "data": [
        {
            "Owner": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "Description": "A sample description.",
            "$currency_symbol": "$",
            "$field_states": null,
            "Website": "www.techwavesolutions.com",
            "$followers": null,
            "$sharing_permission": "full_access",
            "Last_Activity_Time": "2023-06-20T18:31:18+05:30",
            "Record_Image": null,
            "Modified_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "Phone": "+1 (555) 123-4567",
            "Billing_Country": "United States",
            "Account_Name": "TechWave Solutions",
            "id": "2034020000000489159",
            "$zia_visions": null,
            "Modified_Time": "2023-06-20T18:31:18+05:30",
            "Billing_Street": "1234 Main St",
            "Created_Time": "2023-04-21T15:20:19+05:30",
            "$followed": false,
            "$editable": true,
            "Billing_Code": "90210",
            "Billing_City": null,
            "Billing_State": "California",
            "Tag": [
                {
                    "name": "Technology",
                    "id": "2034020000000625001",
                    "color_code": "#D4C9FD"
                }
            ],
            "Created_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "$zia_owner_assignment": "owner_recommendation_unavailable",
            "$approval_state": "approved"
        }
    ]
}

Get details of a pipeline

Retrieves details about a specific pipeline.

Request URL

{api-domain}/bigin/v2/Pipelines/{record_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.modules.ALL
  • ZohoBigin.modules.pipelines.ALL
  • ZohoBigin.modules.pipelines.READ

Request parameters

The available request parameters are given below:

Path parameters

record_id stringRequired

The unique identification (record ID) of a pipeline. You can get the record ID from the Get records API.

Sample request

CurlDeluge
Copiedcurl "https://www.zohoapis.com/bigin/v2/Pipelines/2034020000000489080" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/bigin/v2/Pipelines/2034020000000489080"
type: GET
connection:"connection_link_name"
];
info response;

Response object

The response object contains the following details:

Owner jsonobject

Indicates the owner details of the pipeline record.

Description string

The description about the pipeline record.

$currency_symbol string

A special field indicates the currency symbol associated with the pipeline record.

$field_states string

A special field indicates the states of certain fields in the pipeline record.

$followers string

A special field indicates the followers of the pipeline record.

$sharing_permission string

A special field indicates the level of sharing permission.

Sub_Pipeline string

Indicates the name of the Sub-Pipeline to which the pipeline record belongs.

Closing_Date date

Indicates the expected or actual closing date of the pipeline record.

Last_Activity_Time datetime

The date and time of the last activity associated with the pipeline record.

Modified_By jsonobject

Indicates the user details who have performed the most recent modifications to the pipeline record.

Deal_Name string

Indicates the name of the pipeline record.

Associated_Products jsonarray

Indicates the list of products associated with the pipeline record.

Note: Each associated product has a unique ID, known as the associated product ID. The associated product ID is different from the product ID.

Stage string

Indicates the current stage of the pipeline record within the Sub-Pipeline.

Account_Name jsonobject

Indicates the details of the company to which the pipeline record is associated.

id string

The unique identification of the pipeline record.

Secondary_Contacts jsonarray

Indicates the list of additional contacts associated with the pipeline record.

$zia_visions string

Indicates the details about Zoho Intelligent Assistant (Zia).

Modified_Time datetime

The date and time of the last modification of the pipeline record.

Created_Time datetime

The date and time of when the pipeline record was created.

Amount double

Indicates the amount of the pipeline record.

$followed boolean

A special field indicates whether the pipeline record is followed or not.

$editable boolean

A special field indicates whether the pipeline record is editable or not.

Contact_Name jsonobject

Indicates the details of the contact to which the pipeline record is assigned.

Pipeline string

Indicates the name and ID of the Team Pipeline to which the pipeline record belongs.

Tag jsonarray

Lists the tags associated with the pipeline record.

Created_By jsonobject

Indicates the user details who have created the pipeline record.

$zia_owner_assignment string

Indicates the details of Zia's owner assignment.

$approval_state string

A special field indicates whether the pipeline record is approved or unapproved.

$has_more jsonobject

Indicates whether the subforms, multi-select/multi-user lookup fields associated with the pipeline record contain additional records or not.

Sample response

Copied{
    "data": [
        {
            "Owner": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "Description": null,
            "$currency_symbol": "$",
            "$field_states": null,
            "$followers": null,
            "$sharing_permission": "full_access",
            "Sub_Pipeline": "Sales Pipeline Standard",
            "Closing_Date": null,
            "Last_Activity_Time": "2023-07-18T14:42:49+05:30",
            "Modified_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "Deal_Name": "Adventure Tour Package",
            "Associated_Products": [
                {
                    "Discount": 0,
                    "$in_merge": false,
                    "$field_states": null,
                    "Created_Time": "2023-07-18T14:42:47+05:30",
                    "Total": 2000,
                    "Parent_Id": {
                        "name": "Adventure Tour Package",
                        "id": "2034020000000703001"
                    },
                    "Product": {
                        "name": "Adventure Tour Package",
                        "id": "2034020000000476094"
                    },
                    "Quantity": 1,
                    "List_Price": 2000,
                    "id": "2034020000000703002",
                    "$zia_visions": null
                }
            ],
            "Stage": "Qualification",
            "Account_Name": null,
            "id": "2034020000000703001",
            "Secondary_Contacts": [],
            "$zia_visions": null,
            "Modified_Time": "2023-07-18T14:42:47+05:30",
            "Created_Time": "2023-07-18T14:42:47+05:30",
            "Amount": null,
            "$followed": false,
            "$editable": true,
            "Contact_Name": null,
            "Pipeline": {
                "name": "Sales - Marketing",
                "id": "2034020000000095023"
            },
            "Tag": [],
            "Created_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "$zia_owner_assignment": "owner_recommendation_unavailable",
            "$approval_state": "approved",
            "$has_more": {
                "Secondary_Contacts": false
            }
        }
    ]
}

Get details of a product

Retrieves details about a specific product.

Request URL

{api-domain}/bigin/v2/Products/{record_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.modules.ALL
  • ZohoBigin.modules.products.ALL
  • ZohoBigin.modules.products.READ

Request parameters

The available request parameters are given below:

Path parameters

record_id stringRequired

The unique identification (record ID) of a product. You can get the record ID from the Get records API.

Sample request

CurlDeluge
Copiedcurl "https://www.zohoapis.com/bigin/v2/Products/2034020000000489191" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/bigin/v2/Products/2034020000000489191"
type: GET
connection:"connection_link_name"
];
info response;

Response object

The response object contains the following details:

Product_Category string

Indicates the type or category of the product record.

Owner jsonobject

Indicates the owner details of the product record.

Description string

The description about the product record.

$currency_symbol string

A special field indicates the currency symbol associated with the product record.

$field_states string

A special field indicates the states of certain fields in the product record.

$followers string

A special field indicates the followers of the product record.

$sharing_permission string

A special field indicates the level of sharing permission.

Product_Active boolean

Indicates whether the product record is currently active or not.

Record_Image string

An image associated with the product record.

Modified_By jsonobject

Indicates the user details who have performed the most recent modifications to the product record.

Product_Code string

Indicates the unique code or identifier for the product record.

id string

The unique identification of the product record.

$zia_visions string

Indicates the details about Zoho Intelligent Assistant (Zia).

Modified_Time datetime

The date and time of the last modification of the product record.

Created_Time datetime

The date and time of when the product record was created.

$followed boolean

A special field indicates whether the product record is followed or not.

Product_Name string

Indicates the name of the product record.

$taxable boolean

Indicates whether the product record is currently taxable or not.

$editable boolean

A special field indicates whether the product record is editable or not.

Tag jsonarray

Lists the tags associated with the product record.

Created_By jsonobject

Indicates the user details who have created the product record.

$approval_state string

A special field indicates whether the proved record is approved or unapproved.

Unit_Price double

//change

Indicates the unit price or cost of the product record.

Sample response

Copied{
    "data": [
        {
            "Product_Category": "Vacation",
            "Owner": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "Description": "Escape to a tropical paradise with crystal clear waters, white sandy beaches, and lush greenery. Includes flights, accommodation, and meals.",
            "$currency_symbol": "$",
            "$field_states": null,
            "$followers": null,
            "$sharing_permission": "full_access",
            "Product_Active": true,
            "Record_Image": null,
            "Modified_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "Product_Code": "TROP001",
            "id": "2034020000000489191",
            "$zia_visions": null,
            "Modified_Time": "2023-04-21T17:01:38+05:30",
            "Created_Time": "2023-04-21T17:01:38+05:30",
            "$followed": false,
            "Product_Name": "Tropical Island Getaway",
            "$taxable": true,
            "$editable": true,
            "Tag": [],
            "Created_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "$approval_state": "approved",
            "Unit_Price": 2500
        }
    ]
}

Get details of an event

Retrieves details about a specific event.

Request URL

{api-domain}/bigin/v2/Events/{record_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.modules.ALL
  • ZohoBigin.modules.events.ALL
  • ZohoBigin.modules.events.READ

Request parameters

The available request parameters are given below:

Path parameters

record_id stringRequired

The unique identification (record ID) of a event. You can get the record ID from the Get records API.

Sample request

CurlDeluge
Copiedcurl "https://www.zohoapis.com/bigin/v2/Events/2034020000000478616" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/bigin/v2/Events/2034020000000478616"
type: GET
connection:"connection_link_name"
];
info response;

Response object

The response object contains the following details:

All_day boolean

Indicates whether the event is an all-day event or not.

Owner jsonobject

Indicates the owner details of the event record.

Description string

The description about the event record.

$currency_symbol string

A special field indicates the currency symbol associated with the event record.

$field_states string

A special field indicates the states of certain fields in the event record.

$related_module string

A special field indicates the module related to the event record.

Start_DateTime string

The start date and time of the event in ISO8601 format.

$followers string

A special field indicates the followers of the event record.

$sharing_permission string

A special field indicates the level of sharing permission.

Participants jsonarray

Lists the objects, each representing a participant of the event.

Event_Title string

The title or name of the event.

$calendar_booking_event boolean

Indicates whether the event can be booked through the calendar.

End_DateTime datetime

The end date and time of the event in ISO 8601 format.

Modified_By jsonobject

Indicates the user details who have performed the most recent modifications to the event record.

$event_cancelled boolean

Indicates whether the event is canceled or not.

id string

The unique identification of the event record.

$zia_visions string

Indicates the details about Zoho Intelligent Assistant (Zia).

Remind_At jsonarray

The date and time when a reminder for the event will be sent.

Modified_Time datetime

The date and time of the last modification of the event record.

Venue string

Indicates the location or venue of the event.

Created_Time datetime

The date and time of when the event record was created.

$followed boolean

A special field indicates whether the event record is followed or not.

$editable boolean

A special field indicates whether the event record is editable or not.

$recurrence_id string

Indicates the unique ID of the event recurrence.

$colour_code string

Indicates the colour code of the event record.

Check_In_Time datetime

The date and time when check-in for the event will be available.

Recurring_Activity jsonobject

Indicates the recurring activities associated with the event record.

$meeting_details string

Indicates the details of the meeting associated with the event record.

$u_id jsonobject

An unique identification associated with the event record.

Created_By jsonobject

Indicates the user details who have created the event record.

Tag jsonarray

Lists the tags associated with the event record.

$send_notification jsonobject

Indicates whether notifications are sent for the event or not.

$approval_state string

A special field indicates whether the event record is approved or unapproved.

Related_To jsonobject

Contains the details about the entities related to the event record.

Sample response

Copied{
    "data": [
        {
            "All_day": false,
            "Owner": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "Description": "Join us for a webinar on our Cultural Tour Package. This package is perfect for those interested in exploring new cultures and traditions. Our travel experts will share insights into the package features and help you plan your cultural adventure. You'll also have the opportunity to ask questions and interact with other travelers interested in a cultural tour. This webinar is free, and registration is required.",
            "$currency_symbol": "$",
            "$field_states": null,
            "$related_module": "Deals",
            "Start_DateTime": "2023-07-20T10:00:00+05:30",
            "$followers": null,
            "$sharing_permission": "full_access",
            "Participants": [
                {
                    "Email": "liam.adams@example.com",
                    "name": "Liam Adams",
                    "invited": false,
                    "id": "2034020000000478626",
                    "type": "contact",
                    "participant": "2034020000000478012",
                    "status": "not_known"
                },
                {
                    "Email": "emma.anderson@example.com",
                    "name": "Emma Anderson",
                    "invited": false,
                    "id": "2034020000000478628",
                    "type": "contact",
                    "participant": "2034020000000478028",
                    "status": "not_known"
                },
                {
                    "Email": "noah.bailey@example.com",
                    "name": "Noah Bailey",
                    "invited": false,
                    "id": "2034020000000478630",
                    "type": "contact",
                    "participant": "2034020000000478044",
                    "status": "not_known"
                }
            ],
            "Event_Title": "Cultural Tour Package Webinar",
            "$calendar_booking_event": false,
            "End_DateTime": "2023-07-20T11:30:00+05:30",
            "Modified_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "$event_cancelled": false,
            "id": "2034020000000478616",
            "$zia_visions": null,
            "Remind_At": null,
            "Modified_Time": "2023-04-24T17:03:27+05:30",
            "Venue": "Online (Zoom)",
            "Created_Time": "2023-04-19T18:39:27+05:30",
            "$followed": false,
            "$editable": true,
            "$recurrence_id": null,
            "$colour_code": null,
            "Check_In_Time": null,
            "Recurring_Activity": null,
            "$meeting_details": null,
            "$u_id": "2034020000000478616",
            "Created_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "Tag": [
                {
                    "name": "Online",
                    "id": "2034020000000504266",
                    "color_code": "#FEA7A7"
                }
            ],
            "$send_notification": true,
            "$approval_state": "approved",
            "Related_To": {
                "name": "Cultural Tour Package",
                "id": "2034020000000478248"
            }
        }
    ]
}

Get details of a task

Retrieves details about a specific task.

Request URL

{api-domain}/bigin/v2/Tasks/{record_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.modules.ALL
  • ZohoBigin.modules.tasks.ALL
  • ZohoBigin.modules.tasks.READ

Request parameters

The available request parameters are given below:

Path parameters

record_id stringRequired

The unique identification (record ID) of a task. You can get the record ID from the Get records API.

Sample request

CurlDeluge
Copiedcurl "https://www.zohoapis.com/bigin/v2/Tasks/2034020000000504024" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/bigin/v2/Tasks/2034020000000504024"
type: GET
connection:"connection_link_name"
];
info response;

Response object

The response object contains the following details:

Owner jsonobject

Indicates the owner details of the task record.

Description string

The description about the task record.

$currency_symbol string

A special field indicates the currency symbol associated with the task record.

$field_states string

A special field indicates the states of certain fields in the task record.

Closed_Time datetime

The date and time when the task was closed or completed.

$related_module datetime

A special field indicates the module related to the task record.

$followers string

A special field indicates the followers of the task record.

$sharing_permission string

A special field indicates the level of sharing permission.

Modified_By jsonobject

Indicates the user details who have performed the most recent modifications to the task record.

id string

The unique identification of the task record.

$zia_visions string

Indicates the details about Zoho Intelligent Assistant (Zia).

Remind_At jsonobject

The date and time when a reminder for the task will be sent.

Status string

The status of the task.

Modified_Time datetime

The date and time of the last modification of the task record.

Due_Date date

The due date for completing the task.

Priority string

The priority level of the task.

Created_Time datetime

The date and time of when the task record was created.

$followed boolean

A special field indicates whether the task record is followed or not.

$editable boolean

A special field indicates whether the task record is editable or not.

Subject string

The subject of the task record.

Due_Date date

The due date of the task record.

$u_id boolean

An unique identification associated with the task record.

Created_By jsonobject

Indicates the user details who have created the task record.

Tag jsonarray

Lists the tags associated with the task record.

$zia_owner_assignment string

Indicates the details of Zia's owner assignment.

$approval_state string

A special field indicates whether the task record is approved or unapproved.

$Related_To string

Contains the details about the entities related to the task record.

Sample response

Copied{
    "data": [
        {
            "Owner": {
                "name": "John Smith",
                "id": "2034020000000472114",
                "email": "johnsmith@example.com"
            },
            "Description": "Email the proposal for the Beach Vacation Package to Noah Bailey and follow up to ensure he received it.",
            "$currency_symbol": "$",
            "$field_states": null,
            "Closed_Time": null,
            "$related_module": "Deals",
            "$followers": null,
            "$sharing_permission": "full_access",
            "Modified_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "id": "2034020000000504024",
            "$zia_visions": null,
            "Remind_At": null,
            "Status": "In Progress",
            "Modified_Time": "2023-04-24T14:36:04+05:30",
            "Due_Date": "2023-05-12",
            "Priority": "Normal",
            "Created_Time": "2023-04-24T14:36:04+05:30",
            "$followed": false,
            "$editable": true,
            "Subject": "Send proposal to Noah Bailey",
            "Recurring_Activity": {
                "RRULE": "FREQ=WEEKLY;INTERVAL=1;UNTIL=2023-06-02;BYDAY=FR;DTSTART=2023-05-05"
            },
            "$u_id": "2034020000000504022",
            "Created_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "Tag": [],
            "$zia_owner_assignment": "owner_recommendation_unavailable",
            "$approval_state": "approved",
            "Related_To": {
                "name": "Beach Vacation Package",
                "id": "2034020000000478069"
            }
        }
    ]
}

Get details of a call

Retrieves details about a specific call record.

Request URL

{api-domain}/bigin/v2/Calls/{record_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.modules.ALL
  • ZohoBigin.modules.calls.ALL
  • ZohoBigin.modules.calls.READ

Request parameters

The available request parameters are given below:

Path parameters

record_id stringRequired

The unique identification (record ID) of a call record. You can get the record ID from the Get records API.

Sample request

CurlDeluge
Copiedcurl "https://www.zohoapis.com/bigin/v2/Calls/2034020000000478518" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/bigin/v2/Calls/2034020000000478518"
type: GET
connection:"connection_link_name"
];
info response;

Response object

The response object contains the following details:

Call_Duration string

Indicates the duration of the call in minutes.

Owner jsonobject

Indicates the owner details of the call record.

Description string

The description about the call record.

$currency_symbol string

A special field indicates the currency symbol associated with the call record.

Caller_ID string

The identification of the caller.

$calendar_booking_call string

Indicates whether the call record is booked using calendar or not.

$field_states string

A special field indicates the states of certain fields in the call record.

$followers string

A special field indicates the followers of the call record.

$sharing_permission string

A special field indicates the level of sharing permission.

Call_Agenda string

Indicates the details about the agenda or specific purpose of the call.

Modified_By jsonobject

Indicates the user details who have performed the most recent modifications to the call record.

$telephony_call boolean

Indicates whether the call record is a telephony call or not.

id string

The unique identification of the call record.

Call_Status string

The status of the call.

$zia_visions boolean

Indicates the details about Zoho Intelligent Assistant (Zia).

Modified_Time string

The date and time of the last modification of the call record.

Reminder string

The date and time set for a reminder related to the call record.

Created_Time datetime

The date and time of when the call record was created.

Call_Start_Time datetime

The date and time when the call is scheduled to start.

$followed boolean

A special field indicates whether the call record is followed or not.

$editable boolean

A special field indicates whether the call record is editable or not.

Subject string

The subject or title of the call record.

Call_Type string

Indicates the type of the call.

Call_Duration_in_seconds integer

Indicates the call duration in seconds.

Created_By jsonobject

Indicates the user details who have created the call record.

Tag jsonarray

Lists the tags associated with the call record.

Dialled_Number string

The number dialed for the call.

$approval_state string

A special field indicates whether the call record is approved or unapproved.

Related_To jsonobject

Contains the details about the entities related to the call record.

Sample response

Copied{
    "data": [
        {
            "Call_Duration": null,
            "Owner": {
                "name": "John Smith",
                "id": "2034020000000472114",
                "email": "johnsmith@example.com"
            },
            "Description": null,
            "$currency_symbol": "$",
            "Caller_ID": null,
            "$calendar_booking_call": false,
            "$field_states": null,
            "$related_module": "Deals",
            "$followers": null,
            "$sharing_permission": "full_access",
            "Call_Agenda": "Provide detailed information on the hotel and resort options",
            "Modified_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "$telephony_call": false,
            "id": "2034020000000478502",
            "Call_Status": "Overdue",
            "$zia_visions": null,
            "Modified_Time": "2023-04-19T17:19:38+05:30",
            "Reminder": "2023-05-04T14:00:00+05:30",
            "Created_Time": "2023-04-19T17:19:38+05:30",
            "Call_Start_Time": "2023-05-04T14:00:00+05:30",
            "$followed": false,
            "$editable": true,
            "Subject": "Call scheduled with Liam Adams",
            "Call_Type": "Outbound",
            "Call_Duration_in_seconds": null,
            "Created_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "travel_agency@zylker.com"
            },
            "Tag": [],
            "Dialled_Number": null,
            "$approval_state": "approved",
            "Related_To": {
                "name": "Liam Adam",
                "id": "2034020000000478012"
            }
        }
    ]
}