Asana API
Getting access, Developing, Testing
Back to Asana
Get A Status Update
Returns the complete record for a single status update.
Input
type: object
properties:
parameters:
type: object
properties:
status_gid:
type: string
description: The status update to get.
opt_pretty:
type: boolean
description: >-
Provides “pretty” output.
Provides the response in a “pretty” format. In the case of JSON this
means doing proper line breaking and indentation to make it readable.
This will take extra time and increase the response size so it is
advisable only to use this during debugging.
opt_fields:
type: array
items:
type: string
description: >-
Defines fields to return.
Some requests return *compact* representations of objects in order to
conserve resources and complete the request more efficiently. Other
times requests return more information than you may need. This option
allows you to list the exact set of fields that the API should be sure
to return for the objects. The field names should be provided as
paths, described below.
The id of included objects will always be returned, regardless of the
field options.
required:
- status_gid
title: Parameters
Output
type: object
properties:
data:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
title:
description: The title of the status update.
type: string
example: Status Update - Jun 15
resource_subtype:
type: string
description: >-
The 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.
enum:
- project_status_update
- portfolio_status_update
- goal_status_update
example: project_status_update
readOnly: true
text:
description: The text content of the status update.
type: string
example: The project is moving forward according to plan...
html_text:
description: >-
[Opt In](/docs/inputoutput-options). The text content of the status
update with formatting as HTML.
type: string
example: >-
<body>The project <strong>is</strong> moving forward according to
plan...</body>
status_type:
description: >-
The type associated with the status update. This represents the
current state of the object this object is on.
type: string
enum:
- on_track
- at_risk
- off_track
- on_hold
- complete
- achieved
- partial
- missed
- dropped
author:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: '*Read-only except when same user as requester*. The user’s name.'
example: Greg Sanchez
created_at:
description: The time at which this resource was created.
type: string
format: date-time
readOnly: true
example: '2012-02-22T02:06:58.147Z'
created_by:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: '*Read-only except when same user as requester*. The user’s name.'
example: Greg Sanchez
hearted:
description: >-
*Deprecated - please use liked instead* True if the status is hearted
by the authorized user, false if not.
type: boolean
example: true
readOnly: true
hearts:
description: >-
*Deprecated - please use likes instead* Array of likes for users who
have hearted this status.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: Globally unique identifier of the object, as a string.
type: string
readOnly: true
example: '12345'
user:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: >-
*Read-only except when same user as requester*. The user’s
name.
example: Greg Sanchez
liked:
description: True if the status is liked by the authorized user, false if not.
type: boolean
example: true
likes:
description: Array of likes for users who have liked this status.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: Globally unique identifier of the object, as a string.
type: string
readOnly: true
example: '12345'
user:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: >-
*Read-only except when same user as requester*. The user’s
name.
example: Greg Sanchez
modified_at:
description: >-
The 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.*
type: string
format: date-time
readOnly: true
example: '2012-02-22T02:06:58.147Z'
num_hearts:
description: >-
*Deprecated - please use likes instead* The number of users who have
hearted this status.
type: integer
example: 5
readOnly: true
num_likes:
description: The number of users who have liked this status.
type: integer
example: 5
readOnly: true
parent:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: >-
Name 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.
type: string
example: Stuff to buy