Back to AsanaGet Objects Via Typeahead
Retrieves objects in the workspace based via an auto-completion/typeahead
search algorithm. This feature is meant to provide results quickly, so do
not rely on this API to provide extremely accurate search results. The
result set is limited to a single page of results with a maximum size, so
you won’t be able to fetch large numbers of results.
The typeahead search API provides search for objects from a single
workspace. This endpoint should be used to query for objects when
creating an auto-completion/typeahead search feature. This API is meant
to provide results quickly and should not be relied upon for accurate or
exhaustive search results. The results sets are limited in size and
cannot be paginated.
Queries return a compact representation of each object which is typically
the gid and name fields. Interested in a specific set of fields or all of
the fields?! Of course you are. Use field selectors to manipulate what
data is included in a response.
Resources with type user
are returned in order of most contacted to
least contacted. This is determined by task assignments, adding the user
to projects, and adding the user as a follower to tasks, messages,
etc.
Resources with type project
are returned in order of recency. This is
determined when the user visits the project, is added to the project, and
completes tasks in the project.
Resources with type task
are returned with priority placed on tasks
the user is following, but no guarantee on the order of those tasks.
Resources with type project_template
are returned with priority
placed on favorited project templates.
Leaving the query
string empty or omitted will give you results, still
following the resource ordering above. This could be used to list users or
projects that are relevant for the requesting user's api token.
Input
type: object
properties:
parameters:
type: object
properties:
workspace_gid:
type: string
description: Globally unique identifier for the workspace or organization.
resource_type:
type: string
enum:
- custom_field
- project
- project_template
- portfolio
- tag
- task
- user
default: user
description: >-
The type of values the typeahead should return. You can choose from
one of the following: `custom_field`, `project`, `project_template`,
`portfolio`, `tag`, `task`, and `user`. Note that unlike in the names
of endpoints, the types listed here are in singular form (e.g.
`task`). Using multiple types is not yet supported.
type:
type: string
enum:
- custom_field
- portfolio
- project
- tag
- task
- user
default: user
description: '*Deprecated: new integrations should prefer the resource_type field.*'
query:
type: string
description: >-
The string that will be used to search for relevant objects. If an
empty string is passed in, the API will return results.
count:
type: integer
description: >-
The number of results to return. The default is 20 if this parameter
is omitted, with a minimum of 1 and a maximum of 100. If there are
fewer results found than requested, all will be returned.
opt_pretty:
type: boolean
description: >-
Provides “pretty” output.
Provides the response in a “pretty” format. In the case of JSON this
means doing proper line breaking and indentation to make it readable.
This will take extra time and increase the response size so it is
advisable only to use this during debugging.
opt_fields:
type: array
items:
type: string
description: >-
Defines fields to return.
Some requests return *compact* representations of objects in order to
conserve resources and complete the request more efficiently. Other
times requests return more information than you may need. This option
allows you to list the exact set of fields that the API should be sure
to return for the objects. The field names should be provided as
paths, described below.
The id of included objects will always be returned, regardless of the
field options.
required:
- workspace_gid
- resource_type
title: Parameters
Output
type: object
properties:
data:
type: array
items:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: The name of the object.
type: string
example: Bug Task