Appearance

List Search ​

Endpoint ​

http
GET /unified/search/search
Integrations supported
  • Airtable
  • Asana
  • Azure Active Directory
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • Close
  • Coda
  • Confluence
  • Confluence On Prem
  • Dropbox - Business
  • Dropbox - Personal
  • Freshsales
  • GitHub
  • Gmail
  • Google
  • Google Calendar
  • Google Contacts
  • Google Drive
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Microsoft 365
  • Monday.com
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Readme
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack
  • Trello
  • Zendesk
  • Zoho CRM
  • Zoho Desk
  • Zoho Mail
  • Zoho Projects
  • Zoho Recruit

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 returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
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
  • Airtable
  • Asana
  • Azure Active Directory
  • Azure DevOps
  • Bitbucket
  • Close
  • Coda
  • Confluence
  • Confluence On Prem
  • Dropbox - Business
  • Dropbox - Personal
  • Freshsales
  • GitHub
  • Gmail
  • Google
  • Google Calendar
  • Google Contacts
  • Google Drive
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Microsoft 365
  • Monday.com
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Readme
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack
  • Trello
  • Zendesk
  • Zoho CRM
  • Zoho Desk
  • Zoho Mail
  • Zoho Projects
  • Zoho Recruit
workspace
object

The Airtable Base in which you want to search for the records.

Required in
  • Airtable
id
string
REQUIRED · 

The unique identifier of the Airtable base.

collection
object

The Airtable Table in which you want to search for the records.

Required in
  • Airtable
id
string
REQUIRED · 

The unique identifier of the Airtable table.

workspace_id
string

The unique identifier for the workspace.

Required in
  • Asana
  • Azure DevOps
  • Bitbucket
type
string

The type of the entity to search.

All possible enum values:
  • account
  • application
  • article
  • branch
  • call
  • campaign
  • candidate
  • code
  • collection
  • commit
  • contact
  • conversation
  • department
  • document
  • email
  • event
  • field
  • fork
  • goal
  • interview
  • issue
  • job
  • lead
  • meeting
  • note
  • opportunity
  • portfolio
  • project_template
  • pull_request
  • repository
  • submission
  • tag
  • task
  • team
  • ticket
  • user
Enum support by integration
  • Asana
    • field
    • goal
    • collection
    • project_template
    • portfolio
    • tag
    • ticket
    • team
    • user
  • Bitbucket
    • ticket
    • pull_request
    • tag
    • branch
    • fork
    • code
  • Close
    • account
    • contact
  • GitHub
    • code
    • commit
    • issue
    • pull_request
    • repository
  • HubSpot
    • contact
    • account
    • opportunity
    • note
    • task
    • call
    • email
    • meeting
  • Intercom
    • contact
    • conversation
    • article
    • ticket
  • Linear
    • ticket
    • collection
    • document
  • Zoho CRM
    • lead
    • account
    • contact
    • opportunity
    • campaign
    • task
    • event
    • call
    • note
  • Zoho Recruit
    • candidate
    • application
    • job
    • interview
    • department
    • task
    • submission
    • event
Required in
  • Asana
  • Bitbucket
  • Close
  • GitHub
  • HubSpot
  • Intercom
  • Linear
  • Zoho CRM
  • Zoho Recruit
collection_id
string

The unique identifier of the collection to search within. This is required only when type is either of ticket, branch, tag, fork or pull_request.

Supported in
  • Bitbucket
org_name
string

The name of the organisation to search within

Supported in
  • GitHub
repo_name
string

The name of the repo to search within

Supported in
  • GitHub
product
string

Select the product for which you want to retrieve.

All possible enum values:
  • azure_active_directory
  • calender
  • contacts
  • drive
  • gmail
  • onedrive
  • sharepoint
  • teams
Enum support by integration
  • Google
    • drive
    • calender
    • contacts
    • gmail
  • Microsoft 365
    • teams
    • sharepoint
    • onedrive
    • azure_active_directory
Required in
  • Google
  • Microsoft 365
calendar_id
string
Integration specific notes
  • GoogleThe calendar id. Defaults to primary. Applicable only when product is calender.
  • Google CalendarThe calendar id. Defaults to primary.
Supported in
  • Google
  • Google Calendar
search_in_saved_contacts
boolean
Integration specific notes
  • GoogleSet this value only when product is contacts.
  • Set true if you want to search saved contacts.
All possible enum values:
  • false
  • true
Supported in
  • Google
  • Google Contacts
  • googlepeople
collections
array
Required in
  • Monday.com
account_id
string

The id of the account to search within

Required in
  • Zoho Mail
organization
object
Supported in
  • Zoho Projects
id
string

The unique identifier for a organization.

Response Body ​

result
object[]

List of Search

id
string
REQUIRED · 

The unique identifier of the entity.

Supported in
  • Airtable
  • Asana
  • Azure Active Directory
  • Azure DevOps
  • Bitbucket
  • Close
  • Coda
  • Confluence
  • Confluence On Prem
  • Dropbox - Business
  • Dropbox - Personal
  • Freshsales
  • GitHub
  • Gmail
  • Google
  • Google Calendar
  • Google Contacts
  • Google Drive
  • googlepeople
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Microsoft 365
  • Monday.com
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Readme
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack
  • Trello
  • Zendesk
  • Zoho CRM
  • Zoho Desk
  • Zoho Mail
  • Zoho Projects
  • Zoho Recruit
title
string

The title of the entity.

Supported in
  • Airtable
  • Asana
  • Azure Active Directory
  • Azure DevOps
  • Bitbucket
  • Close
  • Coda
  • Confluence
  • Confluence On Prem
  • Dropbox - Business
  • Dropbox - Personal
  • Freshsales
  • GitHub
  • Gmail
  • Google
  • Google Calendar
  • Google Contacts
  • Google Drive
  • googlepeople
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Microsoft 365
  • Monday.com
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Readme
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack
  • Trello
  • Zendesk
  • Zoho CRM
  • Zoho Desk
  • Zoho Mail
  • Zoho Projects
  • Zoho Recruit
description
string

The description of the entity.

Supported in
  • Asana
  • Bitbucket
  • Close
  • Confluence
  • Confluence On Prem
  • Freshsales
  • GitHub
  • Gmail
  • Google
  • Google Calendar
  • Google Drive
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Microsoft 365
  • Notion
  • OneDrive
  • Outlook Mail
  • Readme
  • Salesforce
  • SharePoint
  • Shortcut
  • Trello
  • Zendesk
  • Zoho CRM
  • Zoho Desk
  • Zoho Mail
  • Zoho Projects
  • Zoho Recruit
type
string

The type of the entity.

Supported in
  • Airtable
  • Asana
  • Azure Active Directory
  • Azure DevOps
  • Bitbucket
  • Close
  • Coda
  • Confluence
  • Confluence On Prem
  • Dropbox - Business
  • Dropbox - Personal
  • Freshsales
  • GitHub
  • Gmail
  • Google
  • Google Calendar
  • Google Contacts
  • Google Drive
  • googlepeople
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Microsoft 365
  • Monday.com
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Readme
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack
  • Trello
  • Zendesk
  • Zoho CRM
  • Zoho Desk
  • Zoho Mail
  • Zoho Projects
  • Zoho Recruit
urls
object[]

The urls of the entity.

Supported in
  • Airtable
  • Asana
  • Azure Active Directory
  • Azure DevOps
  • Bitbucket
  • Close
  • Coda
  • Confluence
  • Confluence On Prem
  • Dropbox - Business
  • Dropbox - Personal
  • Freshsales
  • GitHub
  • Gmail
  • Google
  • Google Calendar
  • Google Contacts
  • Google Drive
  • googlepeople
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Microsoft 365
  • Monday.com
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Readme
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack
  • Trello
  • Zendesk
  • Zoho CRM
  • Zoho Desk
  • Zoho Mail
  • Zoho Projects
  • Zoho Recruit
url
string

The url of the entity.

type
string

The type of the url.

All possible enum values:
  • truto_api
  • truto_download
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.

file_name
string

The name of file. This is available only when the type is truto_download.

mime_type
string

The mime type of file. This is available only when the type is truto_download.

meta
object

The meta data of the entity.

Supported in
  • Asana
  • Azure Active Directory
  • Azure DevOps
  • Bitbucket
  • Close
  • Coda
  • Dropbox - Business
  • Dropbox - Personal
  • GitHub
  • Gmail
  • Google
  • Google Calendar
  • Google Contacts
  • Google Drive
  • googlepeople
  • Jira
  • Linear
  • Microsoft 365
  • Monday.com
  • Microsoft Teams
  • OneDrive
  • Outlook Mail
  • Readme
  • Shortcut
  • Slack
  • Zoho Desk
  • Zoho Mail
created_at
string · date-time

The date when the entity was created.

Supported in
  • Airtable
  • Azure Active Directory
  • Azure DevOps
  • Bitbucket
  • Close
  • Coda
  • GitHub
  • Gmail
  • Google
  • Google Calendar
  • Google Drive
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Microsoft 365
  • Monday.com
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Salesforce
  • SharePoint
  • Shortcut
  • Slack
  • Zendesk
  • Zoho CRM
  • Zoho Desk
  • Zoho Mail
  • Zoho Projects
  • Zoho Recruit
updated_at
string · date-time

The date when the entity was updated.

Supported in
  • Azure DevOps
  • Bitbucket
  • Close
  • Coda
  • Confluence
  • Confluence On Prem
  • Dropbox - Business
  • Dropbox - Personal
  • Freshsales
  • GitHub
  • Google
  • Google Calendar
  • Google Contacts
  • Google Drive
  • googlepeople
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • Microsoft 365
  • Monday.com
  • Microsoft Teams
  • Notion
  • OneDrive
  • Outlook Mail
  • Salesforce
  • SharePoint
  • Shortcut
  • Trello
  • Zendesk
  • Zoho CRM
  • Zoho Desk
  • Zoho Projects
  • Zoho Recruit
children
object[]

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

Supported in
  • Gmail
  • Google
  • Jira
  • Microsoft 365
  • OneDrive
  • Outlook Mail
  • Shortcut
related_resources
object[]
Supported in
  • Microsoft 365
  • Microsoft Teams
  • Outlook Mail
url
string

The url of the entity.

type
string

The type of the url.

All possible enum values:
  • truto_api
  • truto_download
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.

method
string

The Truto method to call

All possible enum values:
  • list
  • get
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.