Asana Typeahead API
The typeahead search API provides search for objects from a single workspace.
OpenAPI Specification
openapi: 3.1.0
info:
title: Asana Allocations Typeahead API
description: The Asana Allocations API allows users to manage and allocate resources within their Asana project management system. An allocation object represents how much of a resource (e.g. person, team) is dedicated to a specific work object (e.g. project, portfolio) over a specific period of time. The effort value can be a percentage or number of hours.
version: '1.0'
termsOfService: https://asana.com/terms
contact:
name: Asana Support
url: https://asana.com/support
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://app.asana.com/api/1.0
description: Main endpoint.
security:
- personalAccessToken: []
- oauth2: []
tags:
- name: Typeahead
description: The typeahead search API provides search for objects from a single workspace.
paths:
/workspaces/{workspace_gid}/typeahead:
parameters:
- $ref: '#/components/parameters/workspace_path_gid'
- name: resource_type
in: query
description: 'The type of values the typeahead should return. You can choose from one of the following: `custom_field`, `goal`, `project`, `project_template`, `portfolio`, `tag`, `task`, `team`, 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.'
required: true
schema:
type: string
enum:
- custom_field
- goal
- project
- project_template
- portfolio
- tag
- task
- team
- user
default: user
- name: type
in: query
description: '*Deprecated: new integrations should prefer the resource_type field.*'
required: false
schema:
type: string
enum:
- custom_field
- portfolio
- project
- tag
- task
- user
default: user
- name: query
in: query
description: The string that will be used to search for relevant objects. If an empty string is passed in, the API will return results.
schema:
type: string
example: Greg
- name: count
in: query
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.
schema:
type: integer
example: 20
- $ref: '#/components/parameters/pretty'
get:
summary: Asana Get objects via typeahead
description: '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.'
tags:
- Typeahead
operationId: typeaheadForWorkspace
parameters:
- name: opt_fields
in: query
description: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
required: false
example:
- name
schema:
type: array
items:
type: string
enum:
- name
style: form
explode: false
responses:
200:
description: Successfully retrieved objects via a typeahead search algorithm.
content:
application/json:
schema:
type: object
description: A generic list of objects, such as those returned by the typeahead search endpoint.
properties:
data:
type: array
items:
$ref: '#/components/schemas/AsanaNamedResource'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/InternalServerError'
x-readme:
code-samples:
- language: java
install: <dependency><groupId>com.asana</groupId><artifactId>asana</artifactId><version>1.0.0</version></dependency>
code: "import com.asana.Client;\n\nClient client = Client.accessToken(\"PERSONAL_ACCESS_TOKEN\");\n\nList<JsonElement> result = client.typeahead.typeaheadForWorkspace(workspaceGid, count, query, type, resourceType)\n .option(\"pretty\", true)\n .execute();"
- language: node
install: npm install asana
code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\nlet token = client.authentications['token'];\ntoken.accessToken = '<YOUR_ACCESS_TOKEN>';\n\nlet typeaheadApiInstance = new Asana.TypeaheadApi();\nlet workspace_gid = \"12345\"; // String | Globally unique identifier for the workspace or organization.\nlet resource_type = \"user\"; // String | The type of values the typeahead should return. You can choose from one of the following: `custom_field`, `goal`, `project`, `project_template`, `portfolio`, `tag`, `task`, `team`, 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.\nlet opts = { \n 'type': \"user\", \n 'query': \"Greg\", \n 'count': 20, \n 'opt_fields': \"name\"\n};\ntypeaheadApiInstance.typeaheadForWorkspace(workspace_gid, resource_type, opts).then((result) => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error) => {\n console.error(error.response.body);\n});"
name: node-sdk-v3
- language: node
install: npm install asana@1.0.5
code: "const asana = require('asana');\n\nconst client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN');\n\nclient.typeahead.typeaheadForWorkspace(workspaceGid, {param: \"value\", param: \"value\", opt_pretty: true})\n .then((result) => {\n console.log(result);\n });"
name: node-sdk-v1
- language: python
install: pip install asana
code: "import asana\nfrom asana.rest import ApiException\nfrom pprint import pprint\n\nconfiguration = asana.Configuration()\nconfiguration.access_token = '<YOUR_ACCESS_TOKEN>'\napi_client = asana.ApiClient(configuration)\n\n# create an instance of the API class\ntypeahead_api_instance = asana.TypeaheadApi(api_client)\nworkspace_gid = \"12345\" # str | Globally unique identifier for the workspace or organization.\nresource_type = \"user\" # str | The type of values the typeahead should return. You can choose from one of the following: `custom_field`, `goal`, `project`, `project_template`, `portfolio`, `tag`, `task`, `team`, 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.\nopts = {\n 'type': \"user\", # str | *Deprecated: new integrations should prefer the resource_type field.*\n 'query': \"Greg\", # str | The string that will be used to search for relevant objects. If an empty string is passed in, the API will return results.\n 'count': 20, # int | 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.\n 'opt_fields': \"name\", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.\n}\n\ntry:\n # Get objects via typeahead\n api_response = typeahead_api_instance.typeahead_for_workspace(workspace_gid, resource_type, opts)\n for data in api_response:\n pprint(data)\nexcept ApiException as e:\n print(\"Exception when calling TypeaheadApi->typeahead_for_workspace: %s\\n\" % e)"
name: python-sdk-v5
- language: python
install: pip install asana==3.2.3
code: 'import asana
client = asana.Client.access_token(''PERSONAL_ACCESS_TOKEN'')
result = client.typeahead.typeahead_for_workspace(workspace_gid, {''param'': ''value'', ''param'': ''value''}, opt_pretty=True)'
name: python-sdk-v3
- language: php
install: composer require asana/asana
code: '<?php
require ''vendor/autoload.php'';
$client = Asana\Client::accessToken(''PERSONAL_ACCESS_TOKEN'');
$result = $client->typeahead->typeaheadForWorkspace($workspace_gid, array(''param'' => ''value'', ''param'' => ''value''), array(''opt_pretty'' => ''true''))'
- language: ruby
install: gem install asana
code: "require 'asana'\n\nclient = Asana::Client.new do |c|\n c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN'\nend\n\nresult = client.typeahead.typeahead_for_workspace(workspace_gid: 'workspace_gid', resource_type: ''resource_type_example'', param: \"value\", param: \"value\", options: {pretty: true})"
components:
parameters:
workspace_path_gid:
name: workspace_gid
in: path
description: Globally unique identifier for the workspace or organization.
required: true
schema:
type: string
example: '12345'
x-env-variable: workspace
pretty:
name: opt_pretty
in: query
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.'
required: false
allowEmptyValue: true
schema:
type: boolean
style: form
example: true
responses:
Forbidden:
description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
NotFound:
description: Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
Unauthorized:
description: A valid authentication token was not provided with the request, so the API could not associate a user with the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
BadRequest:
description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
InternalServerError:
description: There was a problem on Asana’s end. In the event of a server error the response body should contain an error phrase. These phrases can be used by Asana support to quickly look up the incident that caused the server error. Some errors are due to server load, and will not supply an error phrase.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
schemas:
AsanaNamedResource:
description: A generic Asana Resource, containing a globally unique identifier.
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
Error:
type: object
properties:
message:
type: string
readOnly: true
description: Message providing more detail about the error that occurred, if available.
example: 'project: Missing input'
help:
type: string
readOnly: true
description: Additional information directing developers to resources on how to address and fix the problem, if available.
example: 'For more information on API status codes and how to handle them, read the docs on errors: https://asana.github.io/developer-docs/#errors'''
phrase:
type: string
readOnly: true
description: '*500 errors only*. A unique error phrase which can be used when contacting developer support to help identify the exact occurrence of the problem in Asana’s logs.'
example: 6 sad squid snuggle softly
ErrorResponse:
description: 'Sadly, sometimes requests to the API are not successful. Failures can
occur for a wide range of reasons. In all cases, the API should return
an HTTP Status Code that indicates the nature of the failure,
with a response body in JSON format containing additional information.
In the event of a server error the response body will contain an error
phrase. These phrases are automatically generated using the
[node-asana-phrase
library](https://github.com/Asana/node-asana-phrase) and can be used by
Asana support to quickly look up the incident that caused the server
error.'
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
securitySchemes:
personalAccessToken:
type: http
description: A personal access token for the Asana API.
scheme: bearer
oauth2:
type: oauth2
description: OAuth 2.0 authorization code flow.
flows:
authorizationCode:
authorizationUrl: https://app.asana.com/-/oauth_authorize
tokenUrl: https://app.asana.com/-/oauth_token
scopes:
default: Provides access to all endpoints documented in the API reference.