Skip to content

Asana: Get notifications for a user

Asana notifications.getNotificationsForUser: arguments, response, policy and SDK examples.

← Notifications operations · Get started

Operation asana.getnotificationsforuser

Provider route: GET /users/{user_gid}/notifications. 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["notifications"]["getNotificationsForUser"]>[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.notifications.getNotificationsForUser(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.notifications.get_notifications_for_user(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.user_gidstringRequired within parent
queryobjectRequired within parentAdditional keys: not allowed
query.opt_prettybooleanOptional
query.workspacestringRequired within parent
query.limitintegerOptionalMinimum: 1
Maximum: 100
query.offsetstringOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: created_at, created_by, created_by.name, is_read, offset, path, priority_classification, story, story_resource_subtype, uri, work_objects, work_objects.name

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).dataarrayOptional
$ (allOf 1).data[]ModelEach itemExpand Get notifications for a user — response body — data, next page data item — Notification Response
$ (allOf 1).next_pageModelOptionalExpand Get goals — response body — data, next page next page
$ (allOf 2)ModelAll variants applyExpand Get notifications for a user — response body — data, next page

Referenced models: Get goals — response body — data, next page next page, Get notifications for a user — response body — data, next page data item — Notification Response, Get notifications for a user — response body — data, next page

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

Get goals — response body — data, next page next page
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative*Conditional*. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
$ (anyOf 1).offsetstringOptionalPagination offset for the request.
Read only: true
$ (anyOf 1).pathstringOptionalA relative path containing the query parameters to fetch for next_page
Read only: true
$ (anyOf 1).uristringOptionalA full uri containing the query parameters to fetch for next_page
Format: uri
Read only: true
$ (anyOf 2)nullAlternative
Get notifications for a user — response body — data, next page data item — Notification Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get notifications for a user — response body — data, next page data item gid, resource type
$ (allOf 2)objectAll variants apply
$ (allOf 2).priority_classificationstringOptionalThe notification's Priority classification.
Known values: unclassified
Read only: true
$ (allOf 2).story_resource_subtypestringOptionalThe stable public subtype of the Story that produced the notification.
Read only: true
$ (allOf 2).work_objectsarrayOptionalWork referenced by the notification. Each entry is a compact representation of the underlying Asana resource.
Read only: true
$ (allOf 2).work_objects[]ModelEach itemExpand Get objects via typeahead — response body — data data item
$ (allOf 2).storyJSONOptional
$ (allOf 2).story (anyOf 1)objectAlternativeThe Story that produced the notification. This is `null` when the activity is not exposed through the Stories API.
Read only: true
$ (allOf 2).story (anyOf 1) (allOf 1)ModelAll variants applyExpand Get stories from a goal — response body — data, next page data item
$ (allOf 2).story (anyOf 2)nullAlternative
$ (allOf 2).created_byJSONOptional
$ (allOf 2).created_by (anyOf 1)JSONAlternative
$ (allOf 2).created_by (anyOf 1) (allOf 1)ModelAll variants applyExpand Get objects via typeahead — response body — data data item
$ (allOf 2).created_by (anyOf 1) (allOf 2)objectAll variants applyThe computed actor responsible for the underlying activity, or `null` when no actor is available.
Read only: true
$ (allOf 2).created_by (anyOf 2)nullAlternative
$ (allOf 2).created_atstringOptionalThe time at which the notification was created.
Format: date-time
Read only: true
$ (allOf 2).is_readbooleanOptionalWhether the notification is effectively read in the user's Inbox.
Read only: true

Referenced models: Get objects via typeahead — response body — data data item, Get notifications for a user — response body — data, next page data item gid, resource type, Get stories from a goal — response body — data, next page data item

Get notifications for a user — response body — data, next page
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get notifications for a user — response body — data, next page data item — sdk__Notification Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get notifications for a user — response body — data, next page data item — sdk__Notification Response

Get objects via typeahead — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
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 object.
Get notifications for a user — response body — data, next page data item gid, resource type
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get notifications for a user — response body — data, next page data item gid, resource type gid, resource type

Referenced models: Get notifications for a user — response body — data, next page data item gid, resource type gid, resource type

Get stories from a goal — response body — data, next page data item
FieldTypePresenceDescription and constraints
$objectRootA story represents an activity associated with an object in the Asana system.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
comment_gidJSONOptional
comment_gid (anyOf 1)stringAlternative*Conditional*. The GID of this comment's envelope, distinct from the story `gid`. Request with `opt_fields=comment_gid` on story reads. For a top-level task comment, pass this value as `parent_comment` when creating a threaded reply. Null for a legacy comment without an envelope; absent on non-comment stories.
Read only: true
comment_gid (anyOf 2)nullAlternative
anchor_gidJSONOptional
anchor_gid (anyOf 1)stringAlternative*Conditional*. The GID of the object this comment is anchored to. For a top-level task comment this is the task GID; for a threaded reply this is the parent comment's envelope GID (`comment_gid`). Also present on sticker stories. Request with `opt_fields=anchor_gid` on story reads.
Read only: true
anchor_gid (anyOf 2)nullAlternative
created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
created_byModelOptionalExpand Get users in a team — response body — data data item
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.
Read only: true
textstringOptional*Create-only*. Human-readable text for the story or comment.
This will not include the name of the creator.
*Note: This is not guaranteed to be stable for a given type of story. For example, text for a reassignment may not always say “assigned to …” as the text for a story can both be edited and change based on the language settings of the user making the request.*
Use the `resource_subtype` property to discover the action that created the story.

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

Get notifications for a user — response body — data, next page data item gid, resource type gid, resource type
FieldTypePresenceDescription and constraints
$objectRootA *notification* is a recipient-specific record generated for the authenticated user when a story they should be notified about occurs in Asana. Multiple notifications can refer to the same underlying story, one per eligible recipient.
gidstringRequired within parentGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
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.
Get notifications for a user — response body — data, next page data item created by 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.
The computed actor responsible for the underlying activity, or `null` when no actor is available.
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 object.

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

Required provider scopes: ["notifications:read"]

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.