Skip to content

Asana: Get a record

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

← Records operations · Get started

Operation asana.getrecord

Provider route: GET /records/{record_gid}. 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"]["getRecord"]>[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.getRecord(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.get_record(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.record_gidstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
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).dataModelOptionalExpand Get a record — response body — data data — Record Item Response
$ (allOf 2)ModelAll variants applyExpand Get a record — response body — data

Referenced models: Get a record — response body — data data — Record Item Response, Get a record — response body — data

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

Get a record — response body — data data — Record Item Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Search records in a workspace — response body — data data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).tableJSONOptional
$ (allOf 2).table (anyOf 1)JSONAlternative
$ (allOf 2).table (anyOf 1) (allOf 1)ModelAll variants applyExpand Get tables in a workspace — response body — data, next page data item
$ (allOf 2).table (anyOf 1) (allOf 2)JSONAll variants applyThe 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
$ (allOf 2).table (anyOf 2)nullAlternative
$ (allOf 2).workspaceJSONOptional
$ (allOf 2).workspace (allOf 1)ModelAll variants applyExpand Update a workspace — request body — body data
$ (allOf 2).workspace (allOf 2)objectAll variants applyThe workspace this record belongs to.
Read only: true
$ (allOf 2).custom_fieldsarrayOptionalArray of custom field values applied to the record.
$ (allOf 2).custom_fields[]ModelEach itemExpand Get a custom field — response body — data data — Custom Field Response
$ (allOf 2).modified_atstringOptionalThe time at which this record was last modified.
Format: date-time
Read only: true
$ (allOf 2).created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
$ (allOf 2).deleted_atJSONOptional
$ (allOf 2).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
$ (allOf 2).deleted_at (anyOf 2)nullAlternative
$ (allOf 2).created_byModelOptionalExpand Get users in a team — response body — data data item
$ (allOf 2).permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true
$ (allOf 2).comment_countJSONOptional
$ (allOf 2).comment_count (anyOf 1)integerAlternativeThe number of comments on the record.
Read only: true
$ (allOf 2).comment_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).is_in_archived_tablebooleanOptionalTrue if the record's table is archived, false if not.
Read only: true
$ (allOf 2).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 a custom field — response body — data data — Custom Field Response, Search records in a workspace — response body — data data item, Get tables in a workspace — response body — data, next page data item, Get users in a team — response body — data data item, Update a workspace — request body — body data

Get a record — response body — data
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a record — response body — data data — sdk__Record Item Response

Referenced models: Get a record — response body — data data — sdk__Record Item Response

Get a custom field — response body — data data — Custom Field Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a custom field — response body — data / data / format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference
$ (allOf 2)objectAll variants apply
$ (allOf 2).representation_typestringOptionalThis field tells the type of the custom field.
Known values: text, enum, multi_enum, number, date, people, formula, custom_id, reference
Read only: true
$ (allOf 2).id_prefixJSONOptional
$ (allOf 2).id_prefix (anyOf 1)stringAlternativeThis field is the unique custom ID string for the custom field.
$ (allOf 2).id_prefix (anyOf 2)nullAlternative
$ (allOf 2).input_restrictionsarrayOptional
$ (allOf 2).input_restrictions[]stringEach item*Conditional*. Only relevant for custom fields of type `reference`. This array of strings reflects the allowed types of objects that can be written to a `reference` custom field value.
Known values: task, project, portfolio, goal
$ (allOf 2).is_formula_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a formula custom field.
$ (allOf 2).is_lookup_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a lookup custom field.
$ (allOf 2).is_value_read_onlybooleanOptional*Conditional*. This flag describes whether a custom field is read only.
$ (allOf 2).created_byJSONOptional
$ (allOf 2).created_by (anyOf 1)JSONAlternative
$ (allOf 2).created_by (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).created_by (anyOf 1) (allOf 2)JSONAll variants apply
$ (allOf 2).created_by (anyOf 2)nullAlternative
$ (allOf 2).people_valuearrayOptional*Conditional*. Only relevant for custom fields of type `people`. This array of [compact user](/reference/users) objects reflects the values of a `people` custom field.
$ (allOf 2).people_value[]ModelEach itemExpand Get users in a team — response body — data data item
$ (allOf 2).reference_valuearrayOptional*Conditional*. Only relevant for custom fields of type `reference`. This array of objects reflects the values of a `reference` custom field.
$ (allOf 2).reference_value[]ModelEach itemExpand Get objects via typeahead — response body — data data item
$ (allOf 2).html_text_valueJSONOptional
$ (allOf 2).html_text_value (anyOf 1)stringAlternative*Conditional*. Only relevant for custom fields of type `text`. This is the HTML representation of the text value of a custom field, corresponding to the `text_value` plain-text field. See [rich text](/docs/rich-text#reading-rich-text).
Read only: true
$ (allOf 2).html_text_value (anyOf 2)nullAlternative
$ (allOf 2).privacy_settingstringOptionalThe privacy setting of the custom field. *Note: Administrators in your organization may restrict the values of `privacy_setting`.*
Known values: public_with_guests, public, private
$ (allOf 2).default_access_levelstringOptionalThe default access level when inviting new members to the custom field. This isn't applied when the `privacy_setting` is `private`, or the user is a guest. For local fields in a project or portfolio, the user must additionally have permission to modify the container itself.
Known values: admin, editor, user
$ (allOf 2).resource_subtypestringOptionalThe type of the custom field. Must be one of the given values.

Known values: text, enum, multi_enum, number, date, people, reference
Read only: true

Referenced models: Get objects via typeahead — response body — data data item, Get a custom field — response body — data / data / format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference, Get users in a team — response body — data data item

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 tables in a workspace — response body — data, next page data item
FieldTypePresenceDescription and constraints
$objectRootA *table* is a container for structured records (rows), with columns defined by 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 table.
Get users in a team — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *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.

SDK function policy ID: asana.getrecord. Catalog operation: asana:getRecord. 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.