{
"opencollection": "1.0.0",
"info": {
"name": "Helpcenter Search API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Search",
"type": "folder"
},
"items": [
{
"info": {
"name": "Search Tickets",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/tickets/search",
"params": [
{
"name": "ticketNumber",
"value": "",
"type": "query",
"description": "The ticket's serial number !@exact match@!"
},
{
"name": "accountName",
"value": "",
"type": "query",
"description": "Name of the account associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!"
},
{
"name": "subject",
"value": "",
"type": "query",
"description": "Subject of the ticket !@wildcard search@!"
},
{
"name": "departmentId",
"value": "",
"type": "query",
"description": "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
},
{
"name": "channel",
"value": "",
"type": "query",
"description": "The channel through which the ticket was received !@exact match@! !@empty check@! !@not empty check@!"
},
{
"name": "customerResponseTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets in which customer responses were recorded in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! customerResponseTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z2017-11-05T13:15:30.000Z,2018-09-05T13:15:30.000Z"
},
{
"name": "description",
"value": "",
"type": "query",
"description": "Description of the ticket !@wildcard search@!"
},
{
"name": "productName",
"value": "",
"type": "query",
"description": "Name of the product associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!"
},
{
"name": "_all",
"value": "",
"type": "query",
"description": "Key that includes all the columns in the tickets module for search !@wildcard search@!"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Specifies the number of tickets to be fetched. !@default : 10@!"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
},
{
"name": "dueDateRange",
"value": "",
"type": "query",
"description": "Key that filters tickets due in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! dueDateRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@,! !@customerResponseTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!"
},
{
"name": "id",
"value": "",
"type": "query",
"description": "ID of the ticket !@exact match@! "
},
{
"name": "tag",
"value": "",
"type": "query",
"description": "The tag associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!"
},
{
"name": "productId",
"value": "",
"type": "query",
"description": "ID of the product associated with the ticket !@exact match@!"
},
{
"name": "contactId",
"value": "",
"type": "query",
"description": "ID of the contact who raised the ticket !@exact match@! "
},
{
"name": "contactName",
"value": "",
"type": "query",
"description": "The name of the contact who raised the ticket !@wildcard search@!"
},
{
"name": "createdTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "priority",
"value": "",
"type": "query",
"description": "Priority of the ticket !@exact match@!"
},
{
"name": "assigneeId",
"value": "",
"type": "query",
"description": "ID of the agent who is assigned to resolve the ticket !@exact match@!"
},
{
"name": "accountId",
"value": "",
"type": "query",
"description": "ID of the account associated with the ticket !@exact match@!"
},
{
"name": "modifiedTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "category",
"value": "",
"type": "query",
"description": "The category of the ticket !@wildcard search@! !@empty check@! !@not empty check@!"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!"
}
]
},
"docs": "This API searches for tickets in your help desk.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works."
},
{
"info": {
"name": "Search Records",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/:moduleApiName/search",
"params": [
{
"name": "createdTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Specifies the number of tickets to be fetched. !@default : 10@!"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!"
},
{
"name": "modifiedTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "_all",
"value": "",
"type": "query",
"description": "Key that includes all the columns in the tickets module for search !@wildcard search@!"
},
{
"name": "moduleApiName",
"value": "",
"type": "path"
}
]
},
"docs": "This API searches for records in your help desk.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works."
},
{
"info": {
"name": "Search Calls",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/calls/search",
"params": [
{
"name": "ticketNumber",
"value": "",
"type": "query",
"description": "The ticket's serial number !@exact match@!"
},
{
"name": "startDateRange",
"value": "",
"type": "query",
"description": "Key that filters calls that were made in a particular period. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! startDateRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "subject",
"value": "",
"type": "query",
"description": "Subject of the ticket !@wildcard search@!"
},
{
"name": "departmentId",
"value": "",
"type": "query",
"description": "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
},
{
"name": "createdTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "priority",
"value": "",
"type": "query",
"description": "Priority of the ticket !@exact match@!"
},
{
"name": "_all",
"value": "",
"type": "query",
"description": "Key that includes all the columns in the tickets module for search !@wildcard search@!"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Specifies the number of tickets to be fetched. !@default : 10@!"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
},
{
"name": "modifiedTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!"
},
{
"name": "id",
"value": "",
"type": "query",
"description": "ID of the ticket !@exact match@! "
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!"
}
]
},
"docs": "This API searches for the calls in your help desk portal.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works."
},
{
"info": {
"name": "Search Accounts",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/accounts/search",
"params": [
{
"name": "accountName",
"value": "",
"type": "query",
"description": "Name of the account associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!"
},
{
"name": "createdTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Specifies the number of tickets to be fetched. !@default : 10@!"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
},
{
"name": "modifiedTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@,! !@accountName@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!"
},
{
"name": "id",
"value": "",
"type": "query",
"description": "ID of the ticket !@exact match@! "
},
{
"name": "_all",
"value": "",
"type": "query",
"description": "Key that includes all the columns in the tickets module for search !@wildcard search@!"
}
]
},
"docs": "This API searches for accounts in your help desk.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works."
},
{
"info": {
"name": "Search Articles",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/articles/search",
"params": [
{
"name": "departmentId",
"value": "",
"type": "query",
"description": "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
},
{
"name": "createdTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Specifies the number of tickets to be fetched. !@default : 10@!"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
},
{
"name": "modifiedTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!"
},
{
"name": "id",
"value": "",
"type": "query",
"description": "ID of the ticket !@exact match@! "
},
{
"name": "title",
"value": "",
"type": "query",
"description": "title of the help article !@wildcard search@!"
},
{
"name": "categoryId",
"value": "",
"type": "query",
"description": "ID of the Category "
},
{
"name": "_all",
"value": "",
"type": "query",
"description": "Key that includes all the columns in the tickets module for search !@wildcard search@!"
}
]
},
"docs": "This API searches for help articles in your help desk.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works."
},
{
"info": {
"name": "Search Products",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/products/search",
"params": [
{
"name": "contactId",
"value": "",
"type": "query",
"description": "ID of the contact who raised the ticket !@exact match@! "
},
{
"name": "departmentId",
"value": "",
"type": "query",
"description": "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
},
{
"name": "createdTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "productName",
"value": "",
"type": "query",
"description": "Name of the product associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!"
},
{
"name": "_all",
"value": "",
"type": "query",
"description": "Key that includes all the columns in the tickets module for search !@wildcard search@!"
},
{
"name": "accountId",
"value": "",
"type": "query",
"description": "ID of the account associated with the ticket !@exact match@!"
},
{
"name": "productCode",
"value": "",
"type": "query",
"description": "Code of the product !@wildcard search@! !@empty check@! !@not empty check@!"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Specifies the number of tickets to be fetched. !@default : 10@!"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
},
{
"name": "modifiedTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@,! !@productName@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!"
},
{
"name": "id",
"value": "",
"type": "query",
"description": "ID of the ticket !@exact match@! "
}
]
},
"docs": "This API searches for the products in your help desk portal.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works."
},
{
"info": {
"name": "Search Contacts",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/contacts/search",
"params": [
{
"name": "lastName",
"value": "",
"type": "query",
"description": "Last name of the contact !@wildcard search@!"
},
{
"name": "firstName",
"value": "",
"type": "query",
"description": "First name of the contact !@wildcard search@! !@empty check@! !@not empty check@!"
},
{
"name": "accountName",
"value": "",
"type": "query",
"description": "Name of the account associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!"
},
{
"name": "createdTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Specifies the number of tickets to be fetched. !@default : 10@!"
},
{
"name": "fullName",
"value": "",
"type": "query",
"description": "Full name of the contact !@wildcard search@!"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@,! !@lastName@,! !@firstName@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!"
},
{
"name": "modifiedTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "id",
"value": "",
"type": "query",
"description": "ID of the ticket !@exact match@! "
},
{
"name": "_all",
"value": "",
"type": "query",
"description": "Key that includes all the columns in the tickets module for search !@wildcard search@!"
}
]
},
"docs": "This API searches for contacts in your help desk.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works."
},
{
"info": {
"name": "Search Activities",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/activities/search",
"params": [
{
"name": "ticketNumber",
"value": "",
"type": "query",
"description": "The ticket's serial number !@exact match@!"
},
{
"name": "subject",
"value": "",
"type": "query",
"description": "Subject of the ticket !@wildcard search@!"
},
{
"name": "departmentId",
"value": "",
"type": "query",
"description": "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
},
{
"name": "createdTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "priority",
"value": "",
"type": "query",
"description": "Priority of the ticket !@exact match@!"
},
{
"name": "assigneeId",
"value": "",
"type": "query",
"description": "ID of the agent who is assigned to resolve the ticket !@exact match@!"
},
{
"name": "_all",
"value": "",
"type": "query",
"description": "Key that includes all the columns in the tickets module for search !@wildcard search@!"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Specifies the number of tickets to be fetched. !@default : 10@!"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
},
{
"name": "modifiedTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!"
},
{
"name": "id",
"value": "",
"type": "query",
"description": "ID of the ticket !@exact match@! "
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!"
}
]
},
"docs": "This API searches for the activities in your help desk portal.
You can provide comma-separated values, which will perform the search on the field using any of the provided values.
Learn more about search and how it works."
},
{
"info": {
"name": "Search across modules",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/search",
"params": [
{
"name": "searchStr",
"value": "",
"type": "query",
"description": "Keyword or phrase to search"
},
{
"name": "module",
"value": "",
"type": "query",
"description": "Module to search in: @tickets@, @accounts@, @contacts@ or @tasks@. The default response includes all modules."
},
{
"name": "departmentId",
"value": "",
"type": "query",
"description": "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Specifies the number of tickets to be fetched. !@default : 10@!"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Sort by a specific attribute: @relevance@ or @modifiedTime@"
}
]
},
"docs": "This API returns information from all modules or a specific module, based on the value of the module query param."
},
{
"info": {
"name": "Search Tasks",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/tasks/search",
"params": [
{
"name": "ticketNumber",
"value": "",
"type": "query",
"description": "The ticket's serial number !@exact match@!"
},
{
"name": "subject",
"value": "",
"type": "query",
"description": "Subject of the ticket !@wildcard search@!"
},
{
"name": "departmentId",
"value": "",
"type": "query",
"description": "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
},
{
"name": "createdTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "priority",
"value": "",
"type": "query",
"description": "Priority of the ticket !@exact match@!"
},
{
"name": "_all",
"value": "",
"type": "query",
"description": "Key that includes all the columns in the tickets module for search !@wildcard search@!"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Specifies the number of tickets to be fetched. !@default : 10@!"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
},
{
"name": "modifiedTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "dueDateRange",
"value": "",
"type": "query",
"description": "Key that filters tickets due in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! dueDateRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!"
},
{
"name": "id",
"value": "",
"type": "query",
"description": "ID of the ticket !@exact match@! "
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!"
}
]
},
"docs": "This API searches for tasks in your help desk.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works."
},
{
"info": {
"name": "Search Events",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/events/search",
"params": [
{
"name": "ticketNumber",
"value": "",
"type": "query",
"description": "The ticket's serial number !@exact match@!"
},
{
"name": "startDateRange",
"value": "",
"type": "query",
"description": "Key that filters calls that were made in a particular period. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! startDateRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "subject",
"value": "",
"type": "query",
"description": "Subject of the ticket !@wildcard search@!"
},
{
"name": "departmentId",
"value": "",
"type": "query",
"description": "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
},
{
"name": "createdTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "priority",
"value": "",
"type": "query",
"description": "Priority of the ticket !@exact match@!"
},
{
"name": "_all",
"value": "",
"type": "query",
"description": "Key that includes all the columns in the tickets module for search !@wildcard search@!"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Specifies the number of tickets to be fetched. !@default : 10@!"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
},
{
"name": "modifiedTimeRange",
"value": "",
"type": "query",
"description": "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!"
},
{
"name": "id",
"value": "",
"type": "query",
"description": "ID of the ticket !@exact match@! "
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!"
}
]
},
"docs": "This API searches for the events in your help desk portal.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works."
},
{
"info": {
"name": "Search Records by Criteria, Word, Email, or Phone",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/:module/search",
"params": [
{
"name": "module",
"value": "",
"type": "path",
"description": "The API name of the CRM module to search within."
},
{
"name": "approval_state",
"value": "",
"type": "query",
"description": "Filter records by their approval status. This parameter is particularly useful for modules with approval workflows or data validation processes."
},
{
"name": "criteria",
"value": "",
"type": "query",
"description": "Complex query string to search for records using field-specific conditions and operators. Supports up to 15 conditions combined with AND/OR operators. **Format:** `(field_name:operator:value)` with logical operators.\n*Mandatory if email, phone, and word are not present.*"
},
{
"name": "converted",
"value": "",
"type": "query",
"description": "Filter records by their conversion status. Primarily used with Leads module to distinguish between converted and non-converted leads. Also applicable to other modules with conversion workflows."
},
{
"name": "word",
"value": "",
"type": "query",
"description": "A simple word or phrase to search across all supported text fields in the module. Performs a global search with minimum 2 characters required. This is the broadest search method but may be slower than specific field searches.\n*Mandatory if criteria, email, and phone are not present.*"
},
{
"name": "email",
"value": "",
"type": "query",
"description": "Search records by email address across all email fields in the module. Supports partial matches and searches multiple email fields simultaneously.\n*Mandatory if criteria, phone, and word are not present.*"
},
{
"name": "phone",
"value": "",
"type": "query",
"description": "Search records by phone number across all phone fields in the module. Supports various phone number formats including international, national, and partial numbers.\n*Mandatory if criteria, email, and word are not present.*"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of field API names to retrieve in the response. If not specified, all accessible fields are returned. Use this to optimize response size and improve performance."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The page number to retrieve for paginated results. Use in combination with per_page to navigate through large result sets."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "The number of records to return per page. Higher values reduce the number of API calls needed but increase response size and processing time."
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "The field API name to sort the search results by. Choose a field that exists in the target module for consistent sorting behavior."
},
{
"name": "sort_order",
"value": "",
"type": "query",
"description": "The sorting direction for the results. Use 'asc' for ascending (A-Z, 1-9, oldest first) or 'desc' for descending (Z-A, 9-1, newest first)."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Filter users by their status, role, or confirmation state"
}
]
},
"docs": "Searches records matching your criteria within a CRM module. Supports criteria queries, email/phone/word searches. At least one search parameter required. Max 2,000 records, 15 criteria conditions. Newly created records may have indexing delays."
}
]
}
],
"bundled": true
}