Skip to content

Asana: Records schemas

7 Asana schemas with complete fields and constraints.

← Records operations · All schemas

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 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 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 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 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

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.

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.