Appearance

List Search ​

Endpoint ​

http
GET /unified/search/search
Integrations supported
  • Confluence
  • Dropbox - Business
  • Dropbox - Personal
  • FreshSales
  • Gmail
  • Google Calendar
  • Google Drive
  • HubSpot
  • Intercom
  • Jira
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
search_term
string

The search term.

Required in
  • Confluence
  • Dropbox - Business
  • Dropbox - Personal
  • FreshSales
  • Gmail
  • Google Calendar
  • Google Drive
  • HubSpot
  • Intercom
  • Jira
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack
type
string

The type of the entity to search.

All possible enum values:
  • account
  • article
  • call
  • contact
  • conversation
  • email
  • meeting
  • note
  • opportunity
  • task
Enum support by integration
  • Intercom
    • contact
    • conversation
    • article
  • HubSpot
    • contact
    • account
    • opportunity
    • note
    • task
    • call
    • email
    • meeting
Required in
  • HubSpot
  • Intercom
calendar_id
string

The calendar id. Defaults to primary.

Supported in
  • Google Calendar

Response Body ​

result
object[]

List of Search

id
string
REQUIRED · 

The unique identifier of the entity.

Supported in
  • Confluence
  • Dropbox - Business
  • Dropbox - Personal
  • FreshSales
  • Gmail
  • Google Calendar
  • Google Drive
  • HubSpot
  • Intercom
  • Jira
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack
title
string

The title of the entity.

Supported in
  • Confluence
  • Dropbox - Business
  • Dropbox - Personal
  • FreshSales
  • Gmail
  • Google Calendar
  • Google Drive
  • HubSpot
  • Intercom
  • Jira
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack
description
string

The description of the entity.

Supported in
  • Confluence
  • FreshSales
  • Gmail
  • Google Calendar
  • Google Drive
  • HubSpot
  • Intercom
  • Jira
  • Notion
  • OneDrive
  • Outlook Mail
  • Salesforce
  • SharePoint
  • Shortcut
type
string

The type of the entity.

Supported in
  • Confluence
  • Dropbox - Business
  • Dropbox - Personal
  • FreshSales
  • Gmail
  • Google Calendar
  • Google Drive
  • HubSpot
  • Intercom
  • Jira
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack
urls
object[]

The urls of the entity.

Supported in
  • Confluence
  • Dropbox - Business
  • Dropbox - Personal
  • FreshSales
  • Gmail
  • Google Calendar
  • Google Drive
  • HubSpot
  • Intercom
  • Jira
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack
url
string

The url of the entity.

type
string

The type of the url.

unified_model
string

Present when type is truto_api or truto_download. Specifies the unified model of the url.

resource
string

Present when type is truto_api or truto_download. Specifies the resource of the url.

meta
object

The meta data of the entity.

Supported in
  • Dropbox - Business
  • Dropbox - Personal
  • Gmail
  • Google Calendar
  • Google Drive
  • Jira
  • Shortcut
  • Slack
created_at
string · date-time

The date when the entity was created.

Supported in
  • Gmail
  • Google Calendar
  • Google Drive
  • HubSpot
  • Intercom
  • Jira
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack
updated_at
string · date-time

The date when the entity was updated.

Supported in
  • Confluence
  • Dropbox - Business
  • Dropbox - Personal
  • FreshSales
  • Google Calendar
  • Google Drive
  • HubSpot
  • Intercom
  • Jira
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Salesforce
  • SharePoint
  • Shortcut
children
object[]

The children of the entity. Follows the same schema as the parent.

Supported in
  • Gmail
  • Jira
  • Shortcut
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.