Search records in a workspace

get

https://app.asana.com/api/1.0/workspaces/{workspace_gid}/records/search

Required scope: records:read

To mirror the functionality of the Asana web app's advanced search feature, this endpoint allows you to build complex filters to find and retrieve records across all of a workspace's tables.
Custom field filters are also supported, using the same custom_fields.{gid}.* query parameters documented for task search.

Premium access

Like task search, this endpoint is only available to premium Asana users. Making a search request using credentials of a non-premium user will result in a 402 Payment Required error.

Pagination

Search results are not stable; repeating the same query multiple times may return the data in a different order, even if the data do not change. Page sizes are limited to a maximum of 100 items, and can be specified by the limit query parameter.

Eventual consistency

Changes in Asana are forwarded to our search infrastructure to be indexed, which can take between 10 and 60 seconds to complete under normal operation. If you need read-your-write behavior, use Get records in a table instead.

Path Params

workspace_gid

string

required

Globally unique identifier for the workspace or organization.

Query Params

opt_fields

array of strings

This endpoint returns a 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. Properties can include nested fields. To learn more, see the input/output options guide.

opt_fields

opt_pretty

boolean

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.

limit

integer

1 to 100

Results per page.
The number of objects to return per page. The value must be between 1 and 100.

text

string

Performs full-text search on the record name

teams.any

string

Comma-separated list of team IDs

followers.any

string

Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user.

followers.not

string

Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user.

tables.any

string

Comma-separated list of table IDs

tables.not

string

Comma-separated list of table IDs

tables.all

string

Comma-separated list of table IDs

created_on.before

date

ISO 8601 date string

created_on.after

date

ISO 8601 date string

created_on

date | null

ISO 8601 date string or null

created_at.before

date-time

ISO 8601 datetime string

created_at.after

date-time

ISO 8601 datetime string

sort_by

string

enum

Defaults to modified_at

One of created_at or modified_at, defaults to modified_at

Allowed:

sort_ascending

boolean

Defaults to false

Default false

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved the matching records.

400This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.

401A valid authentication token was not provided with the request, so the API could not associate a user with the request.

402The request was valid, but the queried object or object mutation specified in the request is above your current premium level.

403The 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.

404Either 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.

500There 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.