Skip to content

Asana: Search records in a workspace

Asana records.searchRecordsForWorkspace: arguments, response, policy and SDK examples.

← Records operations · Get started

Operation asana.searchrecordsforworkspace

Provider route: GET /workspaces/{workspace_gid}/records/search. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["records"]["searchRecordsForWorkspace"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.records.searchRecordsForWorkspace(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_asana import AsanaIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.records.search_records_for_workspace(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.workspace_gidstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
query.limitintegerOptionalMinimum: 1
Maximum: 100
query.textstringOptional
query.teams.anystringOptional
query.followers.anystringOptional
query.followers.notstringOptional
query.tables.anystringOptional
query.tables.notstringOptional
query.tables.allstringOptional
query.created_on.beforestringOptionalFormat: date
query.created_on.afterstringOptionalFormat: date
query.created_onJSONOptional
query.created_on (anyOf 1)stringAlternativeFormat: date
query.created_on (anyOf 2)nullAlternative
query.created_at.beforestringOptionalFormat: date-time
query.created_at.afterstringOptionalFormat: date-time
query.sort_bystringOptionalOne of: created_at, modified_at
Default: modified_at
query.sort_ascendingbooleanOptionalDefault: false
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: comment_count, created_at, created_by, created_by.name, custom_fields, custom_fields.asana_created_field, custom_fields.created_by, custom_fields.created_by.name, custom_fields.currency_code, custom_fields.custom_label, custom_fields.custom_label_position, custom_fields.date_value, custom_fields.date_value.date, custom_fields.date_value.date_time, custom_fields.default_access_level, custom_fields.description, custom_fields.display_value, custom_fields.enabled, custom_fields.enum_options, custom_fields.enum_options.color, custom_fields.enum_options.enabled, custom_fields.enum_options.name, custom_fields.enum_value, custom_fields.enum_value.color, custom_fields.enum_value.enabled, custom_fields.enum_value.name, custom_fields.format, custom_fields.has_notifications_enabled, custom_fields.html_text_value, custom_fields.id_prefix, custom_fields.input_restrictions, custom_fields.is_formula_field, custom_fields.is_global_to_workspace, custom_fields.is_lookup_field, custom_fields.is_value_read_only, custom_fields.multi_enum_values, custom_fields.multi_enum_values.color, custom_fields.multi_enum_values.enabled, custom_fields.multi_enum_values.name, custom_fields.name, custom_fields.number_value, custom_fields.people_value, custom_fields.people_value.name, custom_fields.precision, custom_fields.privacy_setting, custom_fields.reference_value, custom_fields.reference_value.name, custom_fields.representation_type, custom_fields.resource_subtype, custom_fields.text_value, custom_fields.type, default_access_level, deleted_at, is_in_archived_table, modified_at, name, permalink_url, table, table.name, workspace, workspace.name

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).dataarrayOptional
$ (allOf 1).data[]ModelEach itemExpand Search records in a workspace — response body — data data item
$ (allOf 2)ModelAll variants applyExpand Get records in a table — response body — data, next page

Referenced models: Search records in a workspace — response body — data data item, Get records in a table — response body — data, next page

3 more schemas are linked from the tables above, on the schema pages.

Search records in a workspace — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *record* is a single row in a table. Fields on a record are backed by the table's custom field settings.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the record.
Get records in a table — response body — data, next page
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a record — response body — data data — sdk__Record Item Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get a record — response body — data data — sdk__Record Item Response

Get goals — response body — data, next page next page
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative*Conditional*. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
$ (anyOf 1).offsetstringOptionalPagination offset for the request.
Read only: true
$ (anyOf 1).pathstringOptionalA relative path containing the query parameters to fetch for next_page
Read only: true
$ (anyOf 1).uristringOptionalA full uri containing the query parameters to fetch for next_page
Format: uri
Read only: true
$ (anyOf 2)nullAlternative
Get a record — response body — data data — sdk__Record Item Response
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *record* is a single row in a table. Fields on a record are backed by the table's custom field settings.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the record.
tableJSONOptional
table (anyOf 1)ModelAlternativeExpand Get a record — response body — data data table gid, name, resource type
table (anyOf 2)nullAlternative
workspaceModelOptionalExpand Get a record — response body — data data workspace
custom_fieldsarrayOptionalArray of custom field values applied to the record.
custom_fields[]ModelEach itemExpand Get a task — response body — data data custom fields item
modified_atstringOptionalThe time at which this record was last modified.
Format: date-time
Read only: true
created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
deleted_atJSONOptional
deleted_at (anyOf 1)stringAlternativeThe time at which this resource was deleted, or null if it has not been deleted.
Format: date-time
Read only: true
deleted_at (anyOf 2)nullAlternative
created_byModelOptionalExpand Get an OOO entry — response body — data data user
permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true
comment_countJSONOptional
comment_count (anyOf 1)integerAlternativeThe number of comments on the record.
Read only: true
comment_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
is_in_archived_tablebooleanOptionalTrue if the record's table is archived, false if not.
Read only: true
default_access_levelstringOptionalThe default access level for users who join or are added as members of the record. This isn't applied when the record is private.
Known values: admin, editor, commenter, viewer

Referenced models: Get an OOO entry — response body — data data user, Get a task — response body — data data custom fields item, Get a record — response body — data data table gid, name, resource type, Get a record — response body — data data workspace

Get an OOO entry — response body — data data user
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*Read-only except when same user as requester*. The user's name.
Get a record — response body — data data table gid, name, resource type
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *table* is a container for structured records (rows), with columns defined by custom field settings.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *table* is a container for structured records (rows), with columns defined by custom field settings.
The table that this record belongs to. Omitted if you don't have access to the table, or null if the record has no associated table.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the table.
Get a record — response body — data data workspace
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
The workspace this record belongs to.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the workspace.
Get a custom field — response body — data data date value date, date time
FieldTypePresenceDescription and constraints
$objectRoot*Conditional*. Only relevant for custom fields of type `date`. This object reflects the chosen date (and optionally, time) value of a `date` custom field. If no date is selected, the value of `date_value` will be `null`.
datestringOptionalA string representing the date in YYYY-MM-DD format.
date_timestringOptionalA string representing the date in ISO 8601 format. If no time value is selected, the value of `date-time` will be `null`.

SDK function policy ID: asana.searchrecordsforworkspace. Catalog operation: asana:searchRecordsForWorkspace. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["records:read"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.