Asana: Records schemas
7 Asana schemas with complete fields and constraints.
← Records operations · All schemas
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 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 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 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 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
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. |