Search across modules

GET {{baseUrl}}/api/v1/search?searchStr=:searchStr&departmentId={departmentId}&from={from}&limit={limit}&sortBy={sortField}

This API returns information from all modules or a specific module, based on the value of the module query param.

OAuth Scope

• Desk.search.READ
• Desk.tickets.READ
• Desk.contacts.READ
• Desk.tasks.READ

Request Params

HEADERS

RESPONSES

status: OK

{"data":[{"subject":"Zylker ticket","departmentId":"4000000007043","dueDate":null,"channel":"Phone","onholdTime":null,"sharedDepartments":[],"closedTime":null,"number":"104","contact":{"phone":null,"mobile":"9876543210","name":"Stephen","id":"4000000013012","type":null,"email":null,"account":{"website":null,"name":"Zylker Accounts","id":"4000000008850"}},"createdTime":"2016-06-27T07:22:52.000Z","id":"4000000016009","department":{"name":"Testing","id":"4000000007043"},"email":null,"customerResponseTime":"2016-06-27T07:22:52.117Z","cf":{"cf_featureRequest":false,"cf_region":"Asia"},"productId":"4000000013043","contactId":"4000000013012","module":"tickets","threadCount":"0","team":{"name":"TestingTeam","id":"4000000007235"},"priority":null,"assigneeId":"4000000008692","commentCount":"0","phone":null,"assignee":{"firstName":"","lastName":"jade","photoURL":"https://contacts.zoho.com/file?t=user\u0026ID=10657727","emailId":"jade@zylker.com","id":"4000000008692","zuid":"10657727"},"status":"Open"},{"cf":{"cf_followUpDate":"2016-07-07T19:30:00.000Z","cf_severity":"High"},"ticket":null,"subject":"Wifi adapter not working in zylker","completedTime":null,"module":"tasks","dueDate":"2016-06-27T19:30:00.000Z","description":null,"ownerId":"4000000008692","priority":"High","isCommented":false,"createdBy":"4000000008692","contact":null,"createdTime":"2016-06-27T06:39:48.000Z","id":"4000000013065","assignee":{"firstName":"","lastName":"jade","photoURL":"https://contacts.zoho.com/file?t=user\u0026ID=10657727","emailId":"jade@zylker.com","id":"5000000009116","zuid":"10657727"},"category":null,"department":{"name":"Testing","id":"5000000007235"},"ticketId":null,"status":"Not Started"},{"website":null,"phone":null,"accountName":"Zylker India","customFields":{"city":"Delhi","state":"India"},"module":"accounts","id":"4000000013027","email":null},{"lastName":"Stephen","accountId":"4000000008850","firstName":"Henry","photoURL":null,"phone":null,"customFields":{"customerSince":"2011","editionUsed":"Professional"},"module":"contacts","fullName":"Henry Stephen","id":"4000000013012","ownerId":"4000000008692","email":null,"account":{"website":null,"name":"Zylker India","id":"4000000008850"}}],"count":{"tickets":1,"accounts":1,"tasks":1,"contacts":1}}