Get Record - Detail View

Publish APIs can only be used for published app components.

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.

Note: Publish APIs are supported only for production environment.

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>/publishapi/v2/<account_owner_name>/<app_link_name>/report/<report_link_name>/<record__ID>

Request method

GET

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

Mandatory Parameters

privatelink

Report private link

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/publishapi/v2/jason18/zylker-org/report/All_Employees/3888833000000114027?privatelink=1223456789poiuyytrewq"
-X GET

This sample request will fetch 100 records, from the 50th record, displayed by the All Employees report of the Zylker Org application.

Sample Response

Copied{
  "code": 3000,
  "data": {
    "Multi_Line": "help text desc\nwith \nmulti line",
    "Email": "jason18@zylker.com",
    "Users_single": "boyle@zylker.com",
    "Phone_Number": "202-555-0149",
    "Time": "03:07",
    "Image": "/api/v2/jason18/all-fields/view/all_fields_Report/52129000000076011/Image/download",
    "Url": {
      "title": "zylker",
      "value": "click here",
      "url": "https://www.zylker.com"
    },
    "Name": {
      "display_value": "Jason Bowley",
      "prefix": "",
      "last_name": "Bowley",
      "suffix": "",
      "first_name": "Jason"
    },
    "static_lookup": {
      "display_value": "Choice 3",
      "ID": "52129000000146003"
    },
    "Formula": "180",
    "dynamic_lookup_field": {
      "display_value": "Choice 2",
      "ID": "52129000000094009"
    },
    "Number": "90",
    "Decision_box": "true",
    "Decimal": "10.10",
    "File_upload": "/api/v2/jason18/all-fields/view/all_fields_Report/52129000000076011/File_upload/download",
    "Checkbox": "Select",
    "Currency": "1234567.00",
    "Rich_Text": "<b>Rich text box checking<\/b><div><b>with<\/b><br /><\/div><div><b>nothing else but bold<\/b><br /><\/div>",
    "ID": "52129000000076011",
    "SubForm.File_upload": [
      {
        "display_value": "/api/v2/jason18/all-fields/view/all_fields_Report/52129000000076011/SubForm.File_upload/52129000000076007/download /api/v2/jason/all-fields/view/all_fields_Report/52129000000076011/SubForm.Image/52129000000076007/download",
        "ID": "52129000000076007"
      }
    ],
    "Multi_Select": "Football,Tennis",
    "Percent": "99.90",
    "Dropdown": "Orange",
    "Image1": "https://zylkers.org/files/9469/ftp.jpg",
    "Radio": "Blue",
    "Date_Time": "Wed 11-02-22 12:57:34 PM",
    "Date_field": "Tue 07-30-22",
    "Video": "/api/v2/jason18/all-fields/view/all_fields_Report/52129000000076011/Video/download",
    "Signature": "/api/v2/jason18/all-fields/view/all_fields_Report/52129000000076011/Signature/download",
    "Address_with_map_enabled": {
      "display_value": "10, Downing Street, London, London, United Kingdom",
      "country": "United Kingdom",
      "district_city": "London",
      "latitude": "51.50344025",
      "address_line_1": "10, Downing Street",
      "state_province": "London",
      "address_line_2": "Greens road",
      "postal_code": "91016",
      "longitude": "-0.127708209585621"
    },
    "Audio": "/api/v2/jason18/all-fields/view/all_fields_Report/52129000000076011/Audio/download",
    "Single_Line_Changed": "changed"
  }
}