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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.workspace_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.limit | integer | Optional | Minimum: 1 Maximum: 100 |
query.text | string | Optional | |
query.teams.any | string | Optional | |
query.followers.any | string | Optional | |
query.followers.not | string | Optional | |
query.tables.any | string | Optional | |
query.tables.not | string | Optional | |
query.tables.all | string | Optional | |
query.created_on.before | string | Optional | Format: date |
query.created_on.after | string | Optional | Format: date |
query.created_on | JSON | Optional | |
query.created_on (anyOf 1) | string | Alternative | Format: date |
query.created_on (anyOf 2) | null | Alternative | |
query.created_at.before | string | Optional | Format: date-time |
query.created_at.after | string | Optional | Format: date-time |
query.sort_by | string | Optional | One of: created_at, modified_at Default: modified_at |
query.sort_ascending | boolean | Optional | Default: false |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One 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
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | array | Optional | |
$ (allOf 1).data[] | Model | Each item | Expand Search records in a workspace — response body — data data item |
$ (allOf 2) | Model | All variants apply | Expand 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
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
Search records in a workspace — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *record* is a single row in a table. Fields on a record are backed by the table's custom field settings. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the record. |
Get records in a table — response body — data, next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get a record — response body — data data — sdk__Record Item Response |
next_page | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | *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).offset | string | Optional | Pagination offset for the request. Read only: true |
$ (anyOf 1).path | string | Optional | A relative path containing the query parameters to fetch for next_page Read only: true |
$ (anyOf 1).uri | string | Optional | A full uri containing the query parameters to fetch for next_page Format: uri Read only: true |
$ (anyOf 2) | null | Alternative |
Get a record — response body — data data — sdk__Record Item Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the record. |
table | JSON | Optional | |
table (anyOf 1) | Model | Alternative | Expand Get a record — response body — data data table gid, name, resource type |
table (anyOf 2) | null | Alternative | |
workspace | Model | Optional | Expand Get a record — response body — data data workspace |
custom_fields | array | Optional | Array of custom field values applied to the record. |
custom_fields[] | Model | Each item | Expand Get a task — response body — data data custom fields item |
modified_at | string | Optional | The time at which this record was last modified. Format: date-time Read only: true |
created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
deleted_at | JSON | Optional | |
deleted_at (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
created_by | Model | Optional | Expand Get an OOO entry — response body — data data user |
permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
comment_count | JSON | Optional | |
comment_count (anyOf 1) | integer | Alternative | The number of comments on the record. Read only: true |
comment_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
is_in_archived_table | boolean | Optional | True if the record's table is archived, false if not. Read only: true |
default_access_level | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | *Read-only except when same user as requester*. The user's name. |
Get a record — response body — data data table gid, name, resource type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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.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 |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the table. |
Get a record — response body — data data workspace
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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.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 |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the workspace. |
Get a custom field — response body — data data date value date, date time
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | *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`. |
date | string | Optional | A string representing the date in YYYY-MM-DD format. |
date_time | string | Optional | A string representing the date in ISO 8601 format. If no time value is selected, the value of `date-time` will be `null`. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]