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.
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"]["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 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.get_record(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.record_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
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 | Model | Optional | Expand Get a record — response body — data data — Record Item Response |
$ (allOf 2) | Model | All variants apply | Expand Get a record — response body — data |
Referenced models: Get a record — response body — data data — Record Item Response, Get a record — response body — data
Schemas
Section titled “Schemas”13 more schemas are linked from the tables above, on the schema pages.
Get a record — response body — data data — Record Item Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Search records in a workspace — response body — data data item |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).table | JSON | Optional | |
$ (allOf 2).table (anyOf 1) | JSON | Alternative | |
$ (allOf 2).table (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get tables in a workspace — response body — data, next page data item |
$ (allOf 2).table (anyOf 1) (allOf 2) | JSON | All variants apply | 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 |
$ (allOf 2).table (anyOf 2) | null | Alternative | |
$ (allOf 2).workspace | JSON | Optional | |
$ (allOf 2).workspace (allOf 1) | Model | All variants apply | Expand Update a workspace — request body — body data |
$ (allOf 2).workspace (allOf 2) | object | All variants apply | The workspace this record belongs to. Read only: true |
$ (allOf 2).custom_fields | array | Optional | Array of custom field values applied to the record. |
$ (allOf 2).custom_fields[] | Model | Each item | Expand Get a custom field — response body — data data — Custom Field Response |
$ (allOf 2).modified_at | string | Optional | The time at which this record was last modified. Format: date-time Read only: true |
$ (allOf 2).created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
$ (allOf 2).deleted_at | JSON | Optional | |
$ (allOf 2).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 |
$ (allOf 2).deleted_at (anyOf 2) | null | Alternative | |
$ (allOf 2).created_by | Model | Optional | Expand Get users in a team — response body — data data item |
$ (allOf 2).permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
$ (allOf 2).comment_count | JSON | Optional | |
$ (allOf 2).comment_count (anyOf 1) | integer | Alternative | The number of comments on the record. Read only: true |
$ (allOf 2).comment_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).is_in_archived_table | boolean | Optional | True if the record's table is archived, false if not. Read only: true |
$ (allOf 2).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 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand 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) | object | All variants apply | |
$ (allOf 2).representation_type | string | Optional | This 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_prefix | JSON | Optional | |
$ (allOf 2).id_prefix (anyOf 1) | string | Alternative | This field is the unique custom ID string for the custom field. |
$ (allOf 2).id_prefix (anyOf 2) | null | Alternative | |
$ (allOf 2).input_restrictions | array | Optional | |
$ (allOf 2).input_restrictions[] | string | Each 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_field | boolean | Optional | *Conditional*. This flag describes whether a custom field is a formula custom field. |
$ (allOf 2).is_lookup_field | boolean | Optional | *Conditional*. This flag describes whether a custom field is a lookup custom field. |
$ (allOf 2).is_value_read_only | boolean | Optional | *Conditional*. This flag describes whether a custom field is read only. |
$ (allOf 2).created_by | JSON | Optional | |
$ (allOf 2).created_by (anyOf 1) | JSON | Alternative | |
$ (allOf 2).created_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2).created_by (anyOf 1) (allOf 2) | JSON | All variants apply | |
$ (allOf 2).created_by (anyOf 2) | null | Alternative | |
$ (allOf 2).people_value | array | Optional | *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[] | Model | Each item | Expand Get users in a team — response body — data data item |
$ (allOf 2).reference_value | array | Optional | *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[] | Model | Each item | Expand Get objects via typeahead — response body — data data item |
$ (allOf 2).html_text_value | JSON | Optional | |
$ (allOf 2).html_text_value (anyOf 1) | string | Alternative | *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) | null | Alternative | |
$ (allOf 2).privacy_setting | string | Optional | The 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_level | string | Optional | The 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_subtype | string | Optional | The 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
| 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 tables in a workspace — response body — data, next page data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *table* is a container for structured records (rows), with columns defined by 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 table. |
Get users in a team — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]