Cases

Response Structure


   {
   "data": [
       {
           "Owner": { //Name, ID, and email of the owner of the case
               
                "name": "Patricia Boyle", 
                
                "id": "4150868000000225013",
                
                "email": "patricia.b@zohocorp.com"
            },
            
            "Email": "patricia.b@zylker.com", //Email ID of the contact
            
            "Description": "This is a sample case", //Description of the case
            
            "$currency_symbol": "DA", //The currency in which the revenue is generated
            
            "Internal_Comments": "//comments, if any", //Represents the follow-up notes of the case
            
            "No_of_comments": 0, //The number of comments for the case
            
            "Reported_By": "Patricia Boyle", //Name of the contact who reported the case
            
            "Case_Number": "4150868000002792007", //Unique serial number allocated to the case after its creation
            
            "$review_process": { //Review process details of the case
               
                "approve": false,
                
                "reject": false,
                
                "resubmit": false
            },
            
            "Modified_By": { //Name, ID, and email of the user who modified the case. This is a system-generated field. You cannot modify it.

               
                "name": "Patricia Boyle",
                
                "id": "4150868000000225013",
                
                "email": "patricia.b@zohocorp.com"
            },
            
            "$review": null, //Review process details of the case
            
            "$process_flow": false, //Represents if the record is a blueprint data
            
            "Deal_Name": {  //Name and ID of the Deal associated with the case
               
                "name": "Sample Deal",
                
                "id": "4150868000002782026"
            },
            
            "Exchange_Rate": 3, //Represents the exchange rate of the currency
            
            "Phone": "9090909090", //Phone number of the Contact
            
            "Currency": "DZD", //The currency in which the revenue is generated
            
            "Account_Name": { //Name and ID of the Account the Case is associated with
               
                "name": "Zylker",
                
                "id": "4150868000001416001"
            },
            
            "id": "4150868000002792005", //Unique ID of the case
            
            "$approved": true, //Represents whether the record is approved
            
            "Solution": "Add your solution here",  //Represents the solution to the Case
            
            "Status": "New", //Represents the status of the case. It can be New, Escalated, On Hold, Closed. This is a mandatory field.
            
            "$approval": { //Represents if the current user can approve, delegate, reject, or resubmit the operations performed on this record
               
                "delegate": false,
                
                "approve": false,
                
                "reject": false,
                
                "resubmit": false
            },
            
            "Modified_Time": "2020-08-02T21:55:22+05:30", //Date and time at which the record was last modified. This is a system-generated field. You cannot modify it.
            
            "Priority": "High", //Represents the priority of the case. Values are High, Medium, Low. Default is None.
            
            "Created_Time": "2020-08-02T21:55:22+05:30", //Date and time at which the record was created. This is a system-generated field. You cannot modify it.
            
            "Comments": [], //Represents the follow-up notes for the case
            
            "Product_Name": { //Name and ID of the Product the case is associated with
               
                "name": "sample",
                
                "id": "4150868000002161023"
            },
            
            "$editable": true, //Represents whether the user can edit records in the Cases module
             
            "Add_Comment": null, //Specify the follow-up notes for the case
            "Add_Comment": null, //Specify the follow-up notes for the case
            
            "Case_Origin": "Email", //Represents the source from which the case was generated. Values are Phone, Email, and Web. If you specify web, you must enter the email ID.
            
            "Subject": "This is sample case", //Represents the subject of the case
            
            "Case_Reason": "User did not attend any training.", //Represents why the case was generated
            
            "$orchestration": false, //Represents if the record is associated with orchestration process
            
            "Type": "Problem", //Represents the type of problem
            
            "$in_merge": false,
            
            "Tag": [], //List of tags associated with the record
            
            "Created_By": { //Name and ID of the user who created the record. This is a system-generated field. You cannot modify it.
               
                "name": "Patricia Boyle",
                
                "id": "4150868000000225013",
                
                "email": "patricia.b@zohocorp.com"
            },
            
            "$approval_state": "approved", //Represents if the record is approved
            
            "Related_To": { //Name and ID of the contact who submitted the case
               
                "name": "Patricia Boyle",
                
                "id": "4150868000002780035"
            }
        }
    ]
}
    

Note:

  • The fields beginning with "$" indicate that they do not appear on the Zoho CRM UI, but contain important data. They are read-only fields.
  • For more information about sample attributes, refer Get List of Records.