Get objects via typeahead
GET
/workspaces/{workspace_gid}/typeahead
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.
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.
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.
user are returned in order of most contacted toleast contacted. This is determined by task assignments, adding the user
to projects, and adding the user as a follower to tasks, messages,
etc.
project are returned in order of recency. This isdetermined when the user visits the project, is added to the project, and
completes tasks in the project.
task are returned with priority placed on tasksthe user is following, but no guarantee on the order of those tasks.
query string empty or omitted will give you results, stillfollowing the resource ordering above. This could be used to list users or
projects that are relevant for the requesting user's api token.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://app.asana.com/api/1.0/workspaces//typeahead'Response Response Example
200 - Example 1
{
"data": [
{
"gid": "12345",
"resource_type": "task",
"name": "Bug Task"
}
]
}Request
Path Params
workspace_gid
string
required
Responses
Modified at 2022-09-13 02:00:32