Zoho CRM Fetch Full Data

{
  "openapi": "3.1.0",
  "info": {
    "title": "Fetch Full Data",
    "description": "Rich Text Fields allow users to input formatted text of up to 50,000 characters, including HTML elements. These fields are ideal for entries that require styling and organization, such as product descriptions or client communications. The 'fetch_full_data' API retrieves the complete content of rich text fields for a specific record or multiple records.",
    "version": "8"
  },
  "servers": [
    {
      "url": "https://zohoapis.{dc}/crm/{version}",
      "description": "API Server URL",
      "variables": {
        "dc": {
          "enum": [
            "com",
            "eu",
            "in",
            "cn",
            "au"
          ],
          "default": "com",
          "description": "API Server URL TLD"
        },
        "version": {
          "default": "v8",
          "description": "API Version"
        }
      }
    }
  ],
  "security": [
    {
      "iam-oauth2-schema": [
        "ZohoCRM.modules.READ"
      ]
    }
  ],
  "paths": {
    "/{moduleApiName}/actions/fetch_full_data": {
      "get": {
        "summary": "Fetch full data for multiple records",
        "operationId": "fetchFullDataForMultipleRecords",
        "parameters": [
          {
            "$ref": "#/components/parameters/ModuleApiName"
          },
          {
            "$ref": "#/components/parameters/Fields",
            "required": true
          },
          {
            "$ref": "#/components/parameters/Ids"
          }
        ],
        "description": "Fetches the full content of rich text fields for multiple records. The 'fields' parameter is mandatory and supports a maximum of 8 rich text fields.",
        "responses": {
          "200": {
            "description": "Successful response containing the full content of rich text fields for the requested records.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "description": "Response containing full content of rich text fields",
                  "additionalProperties": false,
                  "properties": {
                    "data": {
                      "type": "array",
                      "description": "Array of records with their rich text field content",
                      "maxItems": 200,
                      "items": {
                        "type": "object",
                        "description": "Record with rich text field values",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The unique identifier of the record.",
                            "format": "int64"
                          }
                        },
                        "additionalProperties": {
                          "type": "string",
                          "description": "The full content of a rich text field, including HTML formatting. The property name corresponds to the API name of the rich text field.",
                          "maxLength": 50000
                        },
                        "required": [
                          "id"
                        ]
                      }
                    }
                  },
                  "required": [
                    "data"
                  ]
                }
              }
            }
          },
          "204": {
            "$ref": "#/components/responses/NoContentResponse"
          },
          "400": {
            "description": "Bad Request. The request could not be understood or was missing required parameters.",
            "content": {
              "application/json": {
                "schema": {
                  "description": "Error response for multiple records fetch full data operation",
                  "oneOf": [
                    {
                      "type": "object",
                      "description": "Invalid module error response",
                      "additionalProperties": false,
                      "properties": {
                        "code": {
                          "type": "string",
                          "enum": [
                            "INVALID_MODULE"
                          ],
                          "description": "Error code indicating the module api name is invalid."
                        },
                        "details": {
                          "type": "object",
                          "description": "Error details with resource path index",
                          "additionalProperties": false,
                          "properties": {
                            "resource_path_index": {
                              "type": "integer",
                              "format": "int32",
                              "description": "Index of the resource path that caused the error."
                            }
                          },
                          "required": [
                            "resource_path_index"
                          ]
                        },
                        "message": {
                          "type": "string",
                          "description": "Human-readable error message",
                          "maxLength": 500
                        },
                        "status": {
                          "type": "string",
                          "description": "Status of the response",
                          "enum": [
                            "error"
                          ]
                        }
                      },
                      "required": [
                        "code",
                        "details",
                        "message",
                        "status"
                      ]
                    },
                    {
                      "type": "object",
                      "description": "Required parameter missing error response",
                      "additionalProperties": false,
                      "properties": {
                        "code": {
                          "type": "string",
                          "enum": [
                            "REQUIRED_PARAM_MISSING"
                          ],
                          "description": "Error code indicating a required parameter is missing."
                        },
                        "details": {
                          "type": "object",
                          "description": "Error details with parameter name",
                          "additionalProperties": false,
                          "properties": {
                            "param_name": {
                              "type": "string",
                              "description": "The name of the missing parameter.",
                              "maxLength": 100
                            }
                          },
                          "required": [
                            "param_name"
                          ]
                        },
                        "message": {
                          "type": "string",
                          "description": "Human-readable error message",
                          "maxLength": 500
                        },
                        "status": {
                          "type": "string",
                          "description": "Status of the response",
                          "enum": [
                            "error"
                          ]
                        }
                      },
                      "required": [
                        "code",
                        "details",
                        "message",
                        "status"
                      ]
                    },
                    {
                      "type": "object",
                      "description": "Invalid request error response",
                      "additionalProperties": false,
                      "properties": {
                        "code": {
                          "type": "string",
                          "enum": [
                            "INVALID_REQUEST"
                          ],
                          "description": "Error code indicating the request is invalid."
                        },
                        "details": {
                          "type": "object",
                          "description": "Additional details about the error.",
                          "additionalProperties": true
                        },
                        "message": {
                          "type": "string",
                          "description": "Human-readable error message",
                          "maxLength": 500
                        },
                        "status": {
                          "type": "string",
                          "description": "Status of the response",
                          "enum": [
                            "error"
                          ]
                        }
                      },
                      "required": [
                        "code",
                        "details",
                        "message",
                        "status"
                      ]
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        },
        "security": [
          {
            "iam-oauth2-schema": [
              "ZohoCRM.modules.READ"
            ]
          }
        ]
      }
    },
    "/{moduleApiName}/{id}/actions/fetch_full_data": {
      "get": {
        "summary": "Fetch full data for a single record",
        "operationId": "fetchFullDataForSingleRecord",
        "parameters": [
          {
            "$ref": "#/components/parameters/ModuleApiName"
          },
          {
            "$ref": "#/components/parameters/Fields"
          },
          {
            "$ref": "#/components/parameters/Id"
          }
        ],
        "description": "Fetches the full content of rich text fields for a specific record. If the 'fields' parameter is not provided, all rich text fields in the module will be fetched.",
        "responses": {
          "200": {
            "description": "Successful response containing the full content of rich text fields for the requested records.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "description": "Response containing full content of rich text fields",
                  "additionalProperties": false,
                  "properties": {
                    "data": {
                      "type": "array",
                      "description": "Array of records with their rich text field content",
                      "maxItems": 1,
                      "items": {
                        "type": "object",
                        "description": "Record with rich text field values",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The unique identifier of the record.",
                            "format": "int64"
                          }
                        },
                        "additionalProperties": {
                          "type": "string",
                          "description": "The full content of a rich text field, including HTML formatting. The property name corresponds to the API name of the rich text field.",
                          "maxLength": 50000
                        },
                        "required": [
                          "id"
                        ]
                      }
                    }
                  },
                  "required": [
                    "data"
                  ]
                }
              }
            }
          },
          "204": {
            "$ref": "#/components/responses/NoContentResponse"
          },
          "400": {
            "description": "Bad Request. The request could not be understood or was missing required parameters.",
            "content": {
              "application/json": {
                "schema": {
                  "description": "Error response for single record fetch full data operation",
                  "oneOf": [
                    {
                      "type": "object",
                      "description": "Invalid module error response",
                      "additionalProperties": false,
                      "properties": {
                        "code": {
                          "type": "string",
                          "enum": [
                            "INVALID_MODULE"
                          ],
                          "description": "Error code indicating the module api name is invalid."
                        },
                        "details": {
                          "type": "object",
                          "description": "Error details with resource path index",
                          "additionalProperties": false,
                          "properties": {
                            "resource_path_index": {
                              "type": "integer",
                              "format": "int32",
                              "description": "Index of the resource path that caused the error."
                            }
                          },
                          "required": [
                            "resource_path_index"
                          ]
                        },
                        "message": {
                          "type": "string",
                          "description": "Human-readable error message",
                          "maxLength": 500
                        },
                        "status": {
                          "type": "string",
                          "description": "Status of the response",
                          "enum": [
                            "error"
                          ]
                        }
                      },
                      "required": [
                        "code",
                        "details",
                        "message",
                        "status"
                      ]
                    },
                    {
                      "type": "object",
                      "description": "Invalid request error response",
                      "additionalProperties": false,
                      "properties": {
                        "code": {
                          "type": "string",
                          "enum": [
                            "INVALID_REQUEST"
                          ],
                          "description": "Error code indicating the request is invalid."
                        },
                        "details": {
                          "type": "object",
                          "description": "Additional details about the error.",
                          "additionalProperties": true
                        },
                        "message": {
                          "type": "string",
                          "description": "Human-readable error message",
                          "maxLength": 500
                        },
                        "status": {
                          "type": "string",
                          "description": "Status of the response",
                          "enum": [
                            "error"
                          ]
                        }
                      },
                      "required": [
                        "code",
                        "details",
                        "message",
                        "status"
                      ]
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        },
        "security": [
          {
            "iam-oauth2-schema": [
              "ZohoCRM.modules.READ"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "parameters": {
      "ModuleApiName": {
        "name": "moduleApiName",
        "in": "path",
        "required": true,
        "description": "The module API name of the record (e.g. Leads, Contacts, Deals, Accounts, Services__s, Price_Books)",
        "schema": {
          "type": "string",
          "maxLength": 50
        }
      },
      "Id": {
        "name": "id",
        "in": "path",
        "required": true,
        "description": "The unique identifier of the record. Must be a valid numeric record ID.",
        "schema": {
          "type": "string",
          "pattern": "^[0-9]+$",
          "minLength": 1,
          "maxLength": 20
        }
      },
      "Ids": {
        "name": "ids",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string",
          "format": "int64"
        },
        "description": "A single string containing a comma-separated list of valid record IDs. The maximum number of IDs allowed is 200."
      },
      "Fields": {
        "name": "fields",
        "in": "query",
        "schema": {
          "type": "string",
          "maxLength": 1000
        },
        "description": "A single string containing a comma-separated list of rich text field API names to fetch."
      }
    },
    "responses": {
      "NoContentResponse": {
        "description": "No record found for the specified record id"
      },
      "InternalServerError": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "description": "Internal server error response object containing code, message, details, and status.",
              "additionalProperties": false,
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Error code indicating the type of error.",
                  "maxLength": 500
                },
                "message": {
                  "type": "string",
                  "description": "Human-readable error message.",
                  "maxLength": 500
                },
                "details": {
                  "type": "object",
                  "description": "Additional details about the error.",
                  "additionalProperties": true
                },
                "status": {
                  "type": "string",
                  "description": "Status of the error response.",
                  "enum": [
                    "error"
                  ]
                }
              },
              "required": [
                "code",
                "message",
                "details",
                "status"
              ]
            }
          }
        }
      },
      "UnauthorizedError": {
        "description": "Unauthorized. The request requires valid authentication or a valid OAuth scope.",
        "content": {
          "application/json": {
            "schema": {
              "description": "Unauthorized error response containing authentication failure or OAuth scope mismatch details.",
              "oneOf": [
                {
                  "type": "object",
                  "description": "Authentication failure response",
                  "additionalProperties": false,
                  "properties": {
                    "code": {
                      "type": "string",
                      "enum": [
                        "AUTHENTICATION_FAILURE"
                      ],
                      "description": "Error code indicating authentication failure."
                    },
                    "details": {
                      "type": "object",
                      "description": "Additional details about the error.",
                      "additionalProperties": true
                    },
                    "message": {
                      "type": "string",
                      "description": "A message describing the authentication failure.",
                      "maxLength": 500
                    },
                    "status": {
                      "type": "string",
                      "description": "The status of the response.",
                      "enum": [
                        "error"
                      ]
                    }
                  },
                  "required": [
                    "code",
                    "details",
                    "message",
                    "status"
                  ]
                },
                {
                  "type": "object",
                  "description": "OAuth scope mismatch response",
                  "additionalProperties": false,
                  "properties": {
                    "code": {
                      "type": "string",
                      "enum": [
                        "OAUTH_SCOPE_MISMATCH"
                      ],
                      "description": "Error code indicating the OAuth scope mismatch."
                    },
                    "details": {
                      "type": "object",
                      "description": "Additional details about the error.",
                      "additionalProperties": true
                    },
                    "message": {
                      "type": "string",
                      "description": "A message describing the OAuth scope mismatch.",
                      "maxLength": 500
                    },
                    "status": {
                      "type": "string",
                      "description": "The status of the response.",
                      "enum": [
                        "error"
                      ]
                    }
                  },
                  "required": [
                    "code",
                    "details",
                    "message",
                    "status"
                  ]
                }
              ]
            }
          }
        }
      }
    },
    "securitySchemes": {
      "iam-oauth2-schema": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
            "tokenUrl": "https://accounts.zoho.com/oauth/v2/token",
            "refreshUrl": "https://accounts.zoho.com/oauth/v2/token",
            "scopes": {
              "ZohoCRM.modules.READ": "READ all CRM modules"
            }
          }
        }
      }
    }
  }
}