Skip to content

Asana: Get a status update

Asana statusUpdates.getStatus: arguments, response, policy and SDK examples.

← Status updates operations · Get started

Operation asana.getstatus

Provider route: GET /status_updates/{status_update_gid}. Alter supplies the connection’s credentials and routing.

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["statusUpdates"]["getStatus"]>[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.statusUpdates.getStatus(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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.status_updates.get_status(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.status_update_gidstringRequired within parent
queryModelOptionalExpand Get a status update — request body — query

Referenced models: Get a status update — request body — query

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).dataModelOptionalExpand Get a status update — response body — data data — Status Update Response
$ (allOf 2)ModelAll variants applyExpand Get a status update — response body — data

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

5 more schemas are linked from the tables above, on the schema pages.

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
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 — 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 story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item
FieldTypePresenceDescription and constraints
$objectRootAn object to represent a user's like.
gidstringOptionalGlobally unique identifier of the object, as a string.
Read only: true
userModelOptionalExpand Get users in a team — response body — data data item

Referenced models: Get users in a team — response body — data data item

Search projects in a workspace — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
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.
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
Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system reaction summary item
FieldTypePresenceDescription and constraints
$objectRootA summary of an emoji reaction on an object.
emoji_basestringOptionalThe emoji base character used in the reaction.
variantstringOptionalThe full emoji string used in the reaction.
countJSONOptional
count (anyOf 1)numberAlternativeThe number of reactions with the emoji variant on the object.
count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reactedbooleanOptionalWhether the current user has reacted with the emoji variant on the object.
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 users in a team — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*Read-only except when same user as requester*. The user's name.

SDK function policy ID: asana.getstatus. Catalog operation: asana:getStatus. 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.

Official provider source

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.