Get Record - Detail View

Overview
OpenAPI Specification
Request Details
Possible Errors

Overview

This API fetches the data displayed in the detail view of a record, which is identified by the ID value passed. This API will not fetch the records displayed in the related data blocks of the detail view.

OpenAPI Specification

The OpenAPI Specification(OAS) is the most widely used standard for API description and refers to a standard interface for describing REST APIs. Download the OAS for the Get Record - Detail View API below:

Request Details

Request URL

https://<base_url>/api/v2/<account_owner_name>/<app_link_name>/report/<report_link_name>/<record_ID>

Request Method

GET

Header

Key	Value	Description
Authorization	Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf	An authentication token (authtoken) allows users to access apps and APIs without having to enter their login credentials each time.
environment	development/stage	Refers to the environment stage.
demo_user_name	demouser_1, demouser_2, demouser_3..	Demo users in your Creator app can be appended along with the environment.

Note: By default, production value will be considered for the environment header.

OAuth Scope

scope=ZohoCreator.report.READ

where,

base_url	Zoho Creator: The base URL of your Creator account For example, it's creator.zoho.com if your account belongs to Zoho's US DC, and is creator.zoho.eu if it belongs to Zoho's EU DC. Zoho Creator On-premise: The base URL specific to your Zoho Creator On-premise account. This URL will be either https://host_name:port_number (learn more) or the hostname of the server where Creator On-prem is running.
account_owner_name	the username of the Creator account's owner
app_link_name	the link name of the target application
report_link_name	the link name of the target report
record_ID	the ID of the record from which you want to get data

Possible Errors

Refer to this page for the list of error codes and messages.

Sample Request for Production environment (for C6 users)

Copiedcurl "https://creator.zoho.com/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114027"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

This sample request will fetch the data that's displayed in the detail view of the record with ID 3888833000000114027 from the All Orders report of the Zylker Store application.

Sample Request for Development/ Stage environments (for C6 users)

Copiedcurl "https://creator.zoho.com/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114027"
-X GET 
-H 'Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf'  
-H 'environment: development'
-H 'demo_user_name: demouser_1'

Sample Response

Copied{
  "code": 3000,
  "data": {
    "Multi_Line": "Multiples\nLines\nof Text",
    "Email": "jason@zylker.com",
    "Address": {
      "display_value": "4154 High Meadow Lane, Scranton, PA, 18503, United States",
      "country": "United States",
      "district_city": "Scranton",
      "latitude": "41.4086874",
      "address_line_1": "4154 High Meadow Lane",
      "state_province": "PA",
      "address_line_2": "",
      "postal_code": "18503",
      "longitude": "-75.6621294"
    },
    "Phone_Number": "+15704961113",
    "Time": "10:30:00",
    "Image": "/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114023/Image/download?filepath=1605793663620_jasonprofile.jpg"",
    "Url": {
      "value": "Zylker Inc",
      "url": "https://www.zylker.com"
    },
    "Name": {
      "display_value": "Mr. Jason Bowley Jr",
      "prefix": "Mr.",
      "last_name": "Bowley",
      "suffix": "Jr",
      "first_name": "Jason"
    },
    "Formula": "Single Line of Text - jason@zylker.com",
    "Single_Line": "Single Line of Text",
    "Number": "20",
    "Decimal": "20.43",
    "Decision_box": "true",
    "File_upload": "/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114023/File_upload/download?filepath=1605793668376_myfile.txt",
    "Checkbox": "Choice 1,Choice 2",
    "Currency": "1230.89",
    "Rich_Text": "<div><b>Rich</b> <i><span class=\"highlight\" style=\"background-color: rgb(254, 255, 51)\">Text</span></i> <u><span class=\"colour\" style=\"color: rgb(51, 51, 255)\">data</span></u>.<br /></div>",
    "Lookup": {
      "display_value": "asdasd",
      "ID": "3888833000000114027"
    },
    "ID": "3888833000000114023",
    "Integration": {
      "display_value": "Webster",
      "ID": "3888833000000114007"
    },
    "Multi_Select": [
        "Choice 2",
        "Choice 3"
      ],
    "Keyword": "Multiples Lines,Text",
    "Percent": "34.34",
    "Prediction": "",
    "Dropdown": "Choice 2",
    "Inline_SubForm": [
      {
        "display_value": "Barry",
        "ID": "3888833000000114013"
      }
    ],
    "Radio": "Choice 1",
    "Auto_Number": "1",
    "users": "jason18",
    "Audio": "/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114023/Audio/download?filepath=1605793663623_audiofile.mp3",
    "Video": "/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114023/Video/download?filepath=1605793663626_videofile.mp4",
    "Signature": "/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114023/Signature/download?filepath=1605793663691_signature.png",
    "Sentiment": "Positive",
    "Date_Time": "24-Apr-2020 10:30:00",
    "Date_field": "24-Apr-2020",
    "Object_Detection": "tv,laptop"
  }
}