Search

Search API

Scope: ZohoProjects.search.READ

Search across portal
GET  /portal/[PORTALID]/search
Search across projects
GET  /portal/[PORTALID]/projects/[PROJECTID]/search

 Search across portal

Lists the modules across the portal based on the search term. The API returns both active and archived projects for the users having admin privileges.

GET  /portal/[PORTALID]/search

Scope: ZohoProjects.search.READ

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringSpecify the search term. Example Key fetaures
moduleStringSpecify the module name.

Sample response

{
  "projects": [
    {
      "owner": {
        "name": "Zoho Projects",
        "id": "10981597"
      },
      "name": "Explore Zoho Projects!",
      "description":Zoho Projects, belonging to the web based project management and collaboration tools, includes an issue tracking software that allows teams to collaborate and get projects done faster.  With Zoho Projects you can post the working status and project members can chat with each other. The Project Stream helps all the team members get immediate updates about the current status of their project. Users easily can keep all content organized and accessible by centrally posting files and easily creating a project web page or documentation."
} ] }

 Search across projects

Lists the search details within a project.

GET  /portal/[PORTALID]/projects/[PROJECTID]/search

Scope: ZohoProjects.search.READ

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringSpecify the search term. Example NE4-I1
moduleStringSpecify the module name.

Sample response

{
  "issue": [
    {
      "status_id": "32163000000007045",
      "issue_id": 32163000000108012,
      "project_id": 32163000000107004,
      "prefix": "NE4-I-1",
      "issue_title": "Issue",
      "project_name": "New1",
      "issue_id_str": "32163000000108011",
      "assignee_name": "Not Assigned",
      "assignee_id": "0"
    }
  ]
}

 Examples

You can search the following modules:

 Projects

Lists all the projects matching the search term.

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringThe search terms can be one of these: name, description, custom field values or prefix ID. Example Marketing
moduleStringModule name should be projects.

Sample response

{
  "projects": [
    {
      "owner": {
        "name": "Helen Collins",
        "id": "639283127"
      },
      "name": "Marketing Collaterals",
      "id": "170876000004865053",
      "status": "active"
    },
    {
      "owner": {
        "name": "Helen Collins",
        "id": "639283127"
      },
      "name": "Marketing",
      "id": "170876000003886007",
      "status": "active"
    },
    {
      "owner": {
        "name": "Helen Collins",
        "id": "639283127"
      },
      "name": "Marketing and Sales",
      "description": "We can discuss all marketing related activities here. All our marketing strategies for email newsletters, campaigns, and signup stats will be shared. Periodical revamp of our website and marketing collaterals will help us in achieving a better hold on our customers and understand user behaviour.
}]}

 Milestones

Lists all the milestones matching the search term.

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringThe search term is the name of the milestone. Example: Floor finishes
moduleStringModule name is milestones.

Sample response

{
  "milestones": [
    {
      "end_date": "04-25-2019",
      "owner_name": "John Marsh",
      "flag": "internal",
      "owner_id": "639282842",
      "start_date_format": "12-06-2018 12:00:00 AM",
      "link": {
        "self": {
          "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000005838007/milestones/170876000005839028/"
        },
        "status": {
          "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000005838007/milestones/170876000005839028/status/"
        }
      },
      "project": {
        "name": "Nakshatra Duplex",
        "id": "170876000005838007"
      },
      "start_date_long": 1544083200000,
      "end_date_long": 1556175600000,
      "end_date_format": "04-25-2019 12:00:00 AM",
      "sequence": 13,
      "name": "Floor finishes",
      "id_string": "170876000005839028",
      "id": 170876000005839040,
      "start_date": "12-06-2018",
      "status": "notcompleted"
    },
    {
      "end_date": "09-13-2018",
      "owner_name": "Helen Collins",
      "flag": "internal",
      "owner_id": "639283127",
      "start_date_format": "08-13-2018 12:00:00 AM",
      "link": {
        "self": {
          "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000004154005/milestones/170876000004154067/"
        },
        "status": {
          "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000004154005/milestones/170876000004154067/status/"
        }
      },
      "project": {
        "name": "Donnelly Apartments Construction",
        "id": "170876000004154005"
      },
      "start_date_long": 1534143600000,
      "end_date_long": 1536908399000,
      "end_date_format": "09-13-2018 11:59:59 PM",
      "completed_date": "09-12-2018",
      "sequence": -1,
      "completed_date_long": 1536755114909,
      "completed_date_format": "09-12-2018 05:25:14 AM",
      "name": "Floor finishes",
      "id_string": "170876000004154067",
      "id": 170876000004154080,
      "start_date": "08-13-2018",
      "status": "completed"
    },
    {
      "end_date": "08-03-2018",
      "owner_name": "John Marsh",
      "flag": "internal",
      "owner_id": "639282842",
      "start_date_format": "03-13-2018 09:00:00 AM",
      "link": {
        "self": {
          "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000005047021/milestones/170876000005049027/"
        },
        "status": {
          "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000005047021/milestones/170876000005049027/status/"
        }
      }
  ]
}

 Tasks

Lists all the tasks matching the search term.

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringThe search term can be name, prefix ID, description. Example: ZMA-T14
moduleStringModule name is tasks.

Sample response

{
  "tasks": [
    {
      "end_date": "09-14-2018",
      "link": {
        "timesheet": {
          "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000005425009/tasks/170876000005426033/logs/"
        },
        "self": {
          "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000005425009/tasks/170876000005426033/"
        }
      },
      "project": {
        "name": "Zylsoft Mobile app",
        "id": "170876000005425009"
      },
      "description": "",
      "start_date_long": 1536595200000,
      "end_date_long": 1536969600000,
      "end_date_format": "09-14-2018 05:00:00 PM",
      "duration": "5",
      "tasklist_id_str": "170876000005426016",
      "last_updated_time_long": 1534759386000,
      "details": {
        "owners": [
          {
            "name": "Eduardo Vargas",
            "id": "2060557"
          }
        ]
      },
      "id": 170876000005426050,
      "tasklist_id": 170876000005426020,
      "key": "ZMA-T14",
      "start_date": "09-10-2018",
      "created_person": "Helen Collins",
      "created_time_long": 1534752067008,
      "created_time": "08-20-2018",
      "is_reminder_set": false,
      "is_recurrence_set": false,
      "created_time_format": "08-20-2018 01:01:07 AM",
      "subtasks": false,
      "work": "40:00",
      "isparent": false,
      "start_date_format": "09-10-2018 09:00:00 AM",
      "work_type": "work_hrs_per_day",
      "task_followers": {
        "FOLUSERS": "",
        "FOLLOWERSIZE": -1,
        "FOLLOWERS": []
      },
      "completed": false,
      "priority": "None",
      "created_by": "639283127",
      "percent_complete": "0",
      "last_updated_time": "08-20-2018",
      "name": "External review report",
      "id_string": "170876000005426033",
      "last_updated_time_format": "08-20-2018 03:03:06 AM",
      "order_sequence": 2,
      "status": {
        "name": "Open",
        "id": "170876000004668068",
        "type": "open",
        "color_code": "#568dd5"
      }
    }
  ]
}

 Tasklists

Returns all the task lists matching the search term.

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringThe search term is the name of the tasklist. Example: Accounts Payable
moduleStringModule name is tasklists.

Sample response

{
  "tasklists": [
    {
      "created_time_long": 1264424625782,
      "created_time": "01-25-2010",
      "flag": "internal",
      "milestone": {
        "end_date": "01-25-2010",
        "owner_name": "Helen Collins",
        "flag": "internal",
        "owner_id": "639283127",
        "start_date_format": "12-31-2009 10:30:00 AM",
        "link": {
          "self": {
            "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000000008005/milestones/170876000000073387/"
          },
          "status": {
            "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000000008005/milestones/170876000000073387/status/"
          }
        },
        "start_date_long": 1262284200000,
        "end_date_long": 1264444199000,
        "end_date_format": "01-25-2010 10:29:59 AM",
        "completed_date": "01-25-2010",
        "sequence": -1,
        "completed_date_long": 1264424800531,
        "completed_date_format": "01-25-2010 05:06:40 AM",
        "name": "Finance Module III",
        "id_string": "170876000000073387",
        "id": 170876000000073380,
        "start_date": "12-31-2009",
        "status": "completed"
      },
      "created_time_format": "01-25-2010 05:03:45 AM",
      "name": "Accounts Receivable",
      "link": {
        "task": {
          "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/tasklists/170876000000073391/tasks/"
        },
        "self": {
          "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/tasklists/170876000000073391/"
        }
      },
      "id_string": "170876000000073391",
      "project": {
        "name": "Budgetting",
        "id": 170876000000008000
      },
      "id": 170876000000073380,
      "completed": false,
      "rolled": false
    },
    {
      "created_time_long": 1253784688777,
      "created_time": "09-24-2009",
      "flag": "internal",
      "milestone": {
        "end_date": "11-20-2009",
        "owner_name": "Helen Collins",
        "flag": "internal",
        "owner_id": "639283127",
        "start_date_format": "09-23-2009 11:59:59 PM",
        "link": {
          "self": {
            "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000000008005/milestones/170876000000022001/"
          },
          "status": {
            "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000000008005/milestones/170876000000022001/status/"
          }
        },
        "start_date_long": 1253775599000,
        "end_date_long": 1258790399000,
        "end_date_format": "11-20-2009 11:59:59 PM",
        "completed_date": "12-16-2009",
        "sequence": -2,
        "completed_date_long": 1260956987023,
        "completed_date_format": "12-16-2009 01:49:47 AM",
        "name": "Finance Module I",
        "id_string": "170876000000022001",
        "id": 170876000000022000,
        "start_date": "09-23-2009",
        "status": "completed"
      }
  ]
}

 Task comments

Provides the details of the task comments matching the search term.

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringThe search term is the content of the comment. Example: meet to discuss this further
moduleStringName of the module is taskcomments

Sample response

{
  "taskcomments": [
    {
      "created_time_long": 1507635927043,
      "created_time": "10-10-2017",
      "created_time_format": "10-10-2017 04:45:27 AM",
      "added_by": "639282842",
      "project": {
        "name": "ZylSoft Mobile App",
        "id": "170876000004597015"
      },
      "added_person": "John Marsh",
      "id": 170876000004859040,
      "content": "Files uploaded. Do take a look. Let's meet to discuss this further."
    }
  ]
}

 Bugs

Fetches all the bugs matching the seach term.

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringThe search term can be name, prefix ID, comments. Example: Close bugs option - Missing in drop-down
moduleStringName of the module is bugs

Sample response

{
  "issue": [
    {
      "status_id": "170876000000065045",
      "issue_id": 170876000001767040,
      "project_id": 170876000001765020,
      "prefix": "EPI-2",
      "issue_title": "Close bugs option - Missing in drop-down",
      "project_name": "Framework Revamp",
      "issue_id_str": "170876000001767025",
      "assignee_name": "Not Assigned",
      "assignee_id": "0"
    }
  ]
}

 Forums

Fetches the forum details matching the specified search criteria.

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringThe search term can be name, description. Example: Budget Tips
moduleStringModule name is forums.

Sample response

{
  "forums": [
    {
      "comment_count": 3,
      "post_date_long": 1539256655374,
      "flag": "internal",
      "link": {
        "self": {
          "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000004154005/forums/170876000005594001/"
        }
      },
      "last_modified_date": "10-11-2018",
      "project": {
        "name": "Donnelly Apartments Construction",
        "id": "170876000004154005"
      },
      "last_activity_date": "12-17-2018",
      "is_sticky_post": true,
      "type": "question",
      "content": y task, goal, and target you must accomplish before releasing a product or service with the features you laid out in the project's onset. part of the initial planning? If you ignore the request to maintain the scope of your project, you could upset the client. But if you accept and underestimate the complexity of the request you could end up missing your This uncontrollable growth in the scope of your project is known as scope creep "
}

 Forum comments

Returns the forum comments matching the search term.

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringThe search term can be the content of the comment. Example: I think if we keep all documentation in the Wiki
moduleStringModule name is forumcomments

Sample response

{
  "forumcomments": [
    {
      "post_date_long": 1545042302706,
      "is_best_answer": false,
      "attachments": [],
      "projects": {
        "name": "Donnelly Apartments Construction",
        "id": "170876000004154005"
      },
      "level": "1",
      "type": "normal",
      "content": "This is a must read for all project managers.",
      "parent_posted_by": "-",
      "posted_person": "Helen Collins",
      "parent_id": "-",
      "post_date": "12-17-2018",
      "posted_by": "639283127",
      "root_id": "-",
      "post_date_format": "12-17-2018 02:25:02 AM",
      "id": 170876000005886000
    },
    {
      "post_date_long": 1544096859000,
      "is_best_answer": false,
      "attachments": [],
      "projects": {
        "name": "Nakshatra Duplex",
        "id": "170876000005838007"
      },
      "level": "1",
      "type": "normal",
      "content": "Any suggestions?",
      "parent_posted_by": "-",
      "posted_person": "Helen Collins",
      "parent_id": "-",
      "post_date": "12-06-2018",
      "posted_by": "639283127",
      "root_id": "-",
      "post_date_format": "12-06-2018 03:47:39 AM",
      "id": 170876000005839000
    },
    {
      "post_date_long": 1539157042896,
      "is_best_answer": false,
      "attachments": [],
      "projects": {
        "name": "Donnelly Apartments Construction",
        "id": "170876000004154005"
      },
      "level": "1",
      "type": "normal",
      "content": "Any updates on these, folks?",
      "parent_posted_by": "-",
      "posted_person": "Kavitha Raj",
      "parent_id": "-",
      "post_date": "10-10-2018",
      "posted_by": "639282843",
      "root_id": "-",
      "post_date_format": "10-10-2018 12:37:22 AM",
      "id": 170876000005584000
    },
    {
      "post_date_long": 1538572168309,
      "is_best_answer": false,
      "attachments": [],
      "projects": {
        "name": "Donnelly Apartments Construction",
        "id": "170876000004154005"
      },
      "level": "1",
      "type": "normal",
      "content": "How about some jute bags like this as a giveaway?",
      "parent_posted_by": "-",
      "posted_person": "Kavitha Raj",
      "parent_id": "-",
      "post_date": "10-03-2018",
      "posted_by": "639282843",
      "root_id": "-",
      "post_date_format": "10-03-2018 06:09:28 AM",
      "id": 170876000005548000
    }
  }

 Events

Fetches the event details as per the search term.

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringThe search term can be the name of the event. Example: New Event
moduleStringModule name is events

Sample response

{
  "events": [
    {
      "occurrences": 1,
      "reminder": "on time",
      "occurred": 0,
      "project": {
        "name": "Testing and Automation",
        "id": 170876000001871100
      },
      "title": "New Event",
      "d_hour": "1 hours",
      "duration_hour": "1 hours",
      "duration_minutes": "0",
      "scheduled_on_to": "12/31/1969",
      "repeat": "only once",
      "location": "Canada",
      "scheduled_on_long": 1545906600000,
      "id": 170876000005906020,
      "scheduled_on": "12/27/2018 02:30 AM"
    }
  ]
}

 Users

Lists the user details matching the search term.

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringThe search term can either be the display name or email address of the user. Example: helen
moduleStringModule name is users

Sample response

{
  "users": [
    {
      "email_id": "helenc@zylker.com",
      "profile_id": "170876000004602134",
      "name": "Helen",
      "last_name": "Collins",
      "id": 639283127,
      "first_name": "Helen"
    }
  ]
}

 Documents

Fetches the document details matching the search term.

Users should provide the following scope ZohoPC.files.READ and ZohoSearch.securesearch.READ to obtain search results in documents module.

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringThe search term is the name of the document. Example: Invoices.
moduleStringModule name is documents

Sample response

{
  "docs": {
    "TOTAL_DOCS": "1",
    "DOCS_LIST": [
      {
        "PERMISSION": 2,
        "AUTHOR_ID": "2060758",
        "FOLDER_ID": "",
        "SCOPE": 1,
        "ENCATTR_DOCNAME": "Invoices.rtf",
        "FILEID": "-1",
        "CREATED_TIME_IN_MILLISECONDS": "",
        "FILE_EXTN": "rtf",
        "DOCID": "voo1n747633db571645aa94c29a8e0c5681a8",
        "WORKSPACE_ID": "voo1nf8ad126663d6482faaec69bfc4722a19",
        "FOLDER_NAME": "",
        "EDIT_ICON": "",
        "LAST_MODIFIEDBY_AUTHOR_NAME": "Patricia Boyle",
        "ENC_DOCNAME": "Invoices.rtf",
        "IS_FAVOURITE": false,
        "ENCURL_AUTHOR_NAME": "Patricia+Boyle",
        "DOC_AUTHOR_NAME": "",
        "SHARED_TIME": "",
        "IS_LOCKED": false,
        "SPACE_ID": "2060758",
        "DOCNAME": "Invoices.rtf",
        "AUTHOR_NAME": "Patricia Boyle",
        "FILETYPE": "docs",
        "TRIM_DOCNAME": "",
        "ENCURL_DOCNAME": "Invoices.rtf",
        "LAST_MODIFIEDTIME_IN_MILLISECONDS": "1374778426000",
        "CLASSNAME": "writericon_css",
        "FOLDER_LEVEL": "shrd-first-level",
        "LAST_MODIFIEDBY": "Patricia Boyle",
        "ENCATTR_AUTHOR_NAME": "Patricia Boyle",
        "LAST_MODIFIEDTIME": "Jul 25, 2013",
        "SERVICE_TYPE": "workspace",
        "LAST_MODIFIEDBY_ENCATTR_AUTHOR_NAME": "Patricia Boyle"
      }
    ]
  }
}

 All

Search across all the modules matching the search terms mentioned above.

Request parameters

indexintIndex for search.
rangeintRange for search.
search_termStringSpecify the search term if any.Example: Helen
moduleStringModule should be All

Sample response

{
  "results": {
    "forums": [
      {
        "comment_count": 0,
        "post_date_long": 1539263386848,
        "flag": "internal",
        "link": {
          "self": {
            "url": "https://preprojects.zoho.com/restapi/portal/2063927/projects/170876000004154005/forums/170876000005594013/"
          }
        },
        "last_modified_date": "10-11-2018",
        "project": {
          "name": "Donnelly Apartments Construction",
          "id": "170876000004154005"
        },
        "last_activity_date": "10-11-2018",
        "is_sticky_post": false,
        "type": "normal",
        "content": "Dear team,I am very happy to invite all of you for a grand success party owing to the launch of Zylker 6.0. We have scheduled it on the 18th of November 2018. We are expected to be at St.Andrews Hall by 4:30 pm. The evening will start with a music concert, some wine-n-dine, and a DJ night. See you there!"
​}
Note
Document search can be done only across projects and not the portal. Other examples apply for search across portal as well as projects.  

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohoprojects.com