Skip to content

Asana: Status updates schemas

10 Asana schemas with complete fields and constraints.

← Status updates operations · All schemas

Create a status update — request body — body / data / resource_subtype: project status update, portfolio status update, goal status update

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Create a status update — request body — body / data / resource_subtype: project status update, portfolio status update, goal status update resource subtype: project status update, portfolio status update, goal status update
$ (allOf 2)objectAll variants apply
$ (allOf 2).textstringRequired within parentThe text content of the status update.
$ (allOf 2).html_textstringOptional[Opt In](/docs/inputoutput-options). The text content of the status update with formatting as HTML. See [rich text](/docs/rich-text).
$ (allOf 2).status_typestringRequired within parentThe type associated with the status update. This represents the current state of the object this object is on.

The valid values for `status_type` depend on the parent of the status update:
- Projects: `on_track`, `at_risk`, `off_track`, `on_hold`, `complete`, `dropped`.
- Portfolios: `on_track`, `at_risk`, `off_track`, `on_hold`, `complete`, `dropped`.
- Goals: `on_track`, `at_risk`, `off_track`, `achieved`, `partial`, `missed`, `dropped`.
One of: on_track, at_risk, off_track, on_hold, complete, achieved, partial, missed, dropped

Referenced models: Create a status update — request body — body / data / resource_subtype: project status update, portfolio status update, goal status update resource subtype: project status update, portfolio status update, goal status update

Create a status update — request body — body / data / resource_subtype: project status update, portfolio status update, goal status update resource subtype: project status update, portfolio status update, goal status update

FieldTypePresenceDescription and constraints
$objectRootA *status update* is an update on the progress of a particular project, portfolio, or goal, and is sent out to all of its parent's followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the object.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
titlestringOptionalThe title of the status update.
resource_subtypestringOptionalThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
The `resource_subtype`s for `status` objects represent the type of their parent.
One of: project_status_update, portfolio_status_update, goal_status_update
Read only: true

Create a status update — request body — body data

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Create a status update — request body — body / data / resource_subtype: project status update, portfolio status update, goal status update
$ (allOf 2)objectAll variants apply
$ (allOf 2).parentstringRequired within parentThe id of parent to send this status update to. This can be a project, goal or portfolio.

Referenced models: Create a status update — request body — body / data / resource_subtype: project status update, portfolio status update, goal status update

Get a status update — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
opt_prettybooleanOptional
opt_fieldsarrayOptional
opt_fields[]stringEach itemOne of: author, author.name, created_at, created_by, created_by.name, hearted, hearts, hearts.user, hearts.user.name, html_text, liked, likes, likes.user, likes.user.name, modified_at, num_hearts, num_likes, parent, parent.name, parent.resource_subtype, reaction_summary, reaction_summary.count, reaction_summary.emoji_base, reaction_summary.reacted, reaction_summary.variant, resource_subtype, status_type, text, title

Get a status update — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a status update — response body — data data — sdk__Status Update Response

Referenced models: Get a status update — response body — data data — sdk__Status Update Response

Get a status update — response body — data / data / resource_subtype: project status update, portfolio status update, goal status update

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get status updates from an object — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).textstringOptionalThe text content of the status update.
$ (allOf 2).html_textstringOptional[Opt In](/docs/inputoutput-options). The text content of the status update with formatting as HTML. See [rich text](/docs/rich-text).
$ (allOf 2).status_typestringOptionalThe type associated with the status update. This represents the current state of the object this object is on.

The valid values for `status_type` depend on the parent of the status update:
- Projects: `on_track`, `at_risk`, `off_track`, `on_hold`, `complete`, `dropped`.
- Portfolios: `on_track`, `at_risk`, `off_track`, `on_hold`, `complete`, `dropped`.
- Goals: `on_track`, `at_risk`, `off_track`, `achieved`, `partial`, `missed`, `dropped`.
Known values: on_track, at_risk, off_track, on_hold, complete, achieved, partial, missed, dropped

Referenced models: Get status updates from an object — response body — data, next page data item

Get a status update — response body — data data — Status Update Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a status update — response body — data / data / resource_subtype: project status update, portfolio status update, goal status update
$ (allOf 2)objectAll variants apply
$ (allOf 2).authorModelOptionalExpand Get users in a team — response body — data data item
$ (allOf 2).created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
$ (allOf 2).created_byModelOptionalExpand Get users in a team — response body — data data item
$ (allOf 2).heartedbooleanOptional*Deprecated - please use liked instead* True if the status is hearted by the authorized user, false if not.
Read only: true
$ (allOf 2).heartsarrayOptional*Deprecated - please use likes instead* Array of likes for users who have hearted this status.
Read only: true
$ (allOf 2).hearts[]ModelEach itemExpand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item
$ (allOf 2).likedbooleanOptionalTrue if the status is liked by the authorized user, false if not.
$ (allOf 2).likesarrayOptionalArray of likes for users who have liked this status.
Read only: true
$ (allOf 2).likes[]ModelEach itemExpand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item
$ (allOf 2).reaction_summaryarrayOptionalSummary of emoji reactions on this status.
Read only: true
$ (allOf 2).reaction_summary[]ModelEach itemExpand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system reaction summary item
$ (allOf 2).modified_atstringOptionalThe time at which this project status was last modified.
*Note: This does not currently reflect any changes in associations such as comments that may have been added or removed from the status.*
Format: date-time
Read only: true
$ (allOf 2).num_heartsJSONOptional
$ (allOf 2).num_hearts (anyOf 1)integerAlternative*Deprecated - please use likes instead* The number of users who have hearted this status.
Read only: true
$ (allOf 2).num_hearts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).num_likesJSONOptional
$ (allOf 2).num_likes (anyOf 1)integerAlternativeThe number of users who have liked this status.
Read only: true
$ (allOf 2).num_likes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).parentJSONOptional
$ (allOf 2).parent (allOf 1)ModelAll variants applyExpand Search projects in a workspace — response body — data data item
$ (allOf 2).parent (allOf 2)objectAll variants applyThe parent of the status update. This can be a project, goal or portfolio, and indicates that this status was sent on that object.

Referenced models: Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item, Search projects in a workspace — response body — data data item, Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system reaction summary item, Get a status update — response body — data / data / resource_subtype: project status update, portfolio status update, goal status update, Get users in a team — response body — data data item

Get a status update — response body — data data — sdk__Status Update Response

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *status update* is an update on the progress of a particular project, portfolio, or goal, and is sent out to all of its parent's followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the object.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
titlestringOptionalThe title of the status update.
resource_subtypestringOptionalThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
The `resource_subtype`s for `status` objects represent the type of their parent.
Known values: project_status_update, portfolio_status_update, goal_status_update
Read only: true
textstringOptionalThe text content of the status update.
html_textstringOptional[Opt In](/docs/inputoutput-options). The text content of the status update with formatting as HTML. See [rich text](/docs/rich-text).
status_typestringOptionalThe type associated with the status update. This represents the current state of the object this object is on.

The valid values for `status_type` depend on the parent of the status update:
- Projects: `on_track`, `at_risk`, `off_track`, `on_hold`, `complete`, `dropped`.
- Portfolios: `on_track`, `at_risk`, `off_track`, `on_hold`, `complete`, `dropped`.
- Goals: `on_track`, `at_risk`, `off_track`, `achieved`, `partial`, `missed`, `dropped`.
Known values: on_track, at_risk, off_track, on_hold, complete, achieved, partial, missed, dropped
authorModelOptionalExpand Get an OOO entry — response body — data data user
created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
created_byModelOptionalExpand Get an OOO entry — response body — data data user
heartedbooleanOptional*Deprecated - please use liked instead* True if the status is hearted by the authorized user, false if not.
Read only: true
heartsarrayOptional*Deprecated - please use likes instead* Array of likes for users who have hearted this status.
Read only: true
hearts[]ModelEach itemExpand Get a goal — response body — data data likes item
likedbooleanOptionalTrue if the status is liked by the authorized user, false if not.
likesarrayOptionalArray of likes for users who have liked this status.
Read only: true
likes[]ModelEach itemExpand Get a goal — response body — data data likes item
reaction_summaryarrayOptionalSummary of emoji reactions on this status.
Read only: true
reaction_summary[]ModelEach itemExpand Get a story — response body — data data reaction summary item
modified_atstringOptionalThe time at which this project status was last modified.
*Note: This does not currently reflect any changes in associations such as comments that may have been added or removed from the status.*
Format: date-time
Read only: true
num_heartsJSONOptional
num_hearts (anyOf 1)integerAlternative*Deprecated - please use likes instead* The number of users who have hearted this status.
Read only: true
num_hearts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_likesJSONOptional
num_likes (anyOf 1)integerAlternativeThe number of users who have liked this status.
Read only: true
num_likes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
parentobjectOptionalA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.
The parent of the status update. This can be a project, goal or portfolio, and indicates that this status was sent on that object.
parent.gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
parent.resource_typestringOptionalThe base type of this resource.
Read only: true
parent.namestringOptionalName of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
parent.resource_subtypestringOptionalThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
Known values: default_project, custom

Referenced models: Get an OOO entry — response body — data data user, Get a goal — response body — data data likes item, Get a story — response body — data data reaction summary item

Get status updates from an object — response body — data, next page

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a status update — response body — data data — sdk__Status Update 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 status update — response body — data data — sdk__Status Update Response

Get status updates from an object — response body — data, next page data item

FieldTypePresenceDescription and constraints
$objectRootA *status update* is an update on the progress of a particular project, portfolio, or goal, and is sent out to all of its parent's followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the object.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
titlestringOptionalThe title of the status update.
resource_subtypestringOptionalThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
The `resource_subtype`s for `status` objects represent the type of their parent.
Known values: project_status_update, portfolio_status_update, goal_status_update
Read only: true

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.