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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.user_gid | string | Required within parent | |
query | object | Required within parent | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.workspace | string | Required within parent | |
query.limit | integer | Optional | Minimum: 1 Maximum: 100 |
query.offset | string | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One 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
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | array | Optional | |
$ (allOf 1).data[] | Model | Each item | Expand Get notifications for a user — response body — data, next page data item — Notification Response |
$ (allOf 1).next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
$ (allOf 2) | Model | All variants apply | Expand 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
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
Get goals — response body — data, next page next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | *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).offset | string | Optional | Pagination offset for the request. Read only: true |
$ (anyOf 1).path | string | Optional | A relative path containing the query parameters to fetch for next_page Read only: true |
$ (anyOf 1).uri | string | Optional | A full uri containing the query parameters to fetch for next_page Format: uri Read only: true |
$ (anyOf 2) | null | Alternative |
Get notifications for a user — response body — data, next page data item — Notification Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get notifications for a user — response body — data, next page data item gid, resource type |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).priority_classification | string | Optional | The notification's Priority classification. Known values: unclassified Read only: true |
$ (allOf 2).story_resource_subtype | string | Optional | The stable public subtype of the Story that produced the notification. Read only: true |
$ (allOf 2).work_objects | array | Optional | Work referenced by the notification. Each entry is a compact representation of the underlying Asana resource. Read only: true |
$ (allOf 2).work_objects[] | Model | Each item | Expand Get objects via typeahead — response body — data data item |
$ (allOf 2).story | JSON | Optional | |
$ (allOf 2).story (anyOf 1) | object | Alternative | The 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) | Model | All variants apply | Expand Get stories from a goal — response body — data, next page data item |
$ (allOf 2).story (anyOf 2) | null | Alternative | |
$ (allOf 2).created_by | JSON | Optional | |
$ (allOf 2).created_by (anyOf 1) | JSON | Alternative | |
$ (allOf 2).created_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get objects via typeahead — response body — data data item |
$ (allOf 2).created_by (anyOf 1) (allOf 2) | object | All variants apply | The computed actor responsible for the underlying activity, or `null` when no actor is available. Read only: true |
$ (allOf 2).created_by (anyOf 2) | null | Alternative | |
$ (allOf 2).created_at | string | Optional | The time at which the notification was created. Format: date-time Read only: true |
$ (allOf 2).is_read | boolean | Optional | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get notifications for a user — response body — data, next page data item — sdk__Notification 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 notifications for a user — response body — data, next page data item — sdk__Notification Response
Get objects via typeahead — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier. |
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 object. |
Get notifications for a user — response body — data, next page data item gid, resource type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A story represents an activity associated with an object in the Asana system. |
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 |
comment_gid | JSON | Optional | |
comment_gid (anyOf 1) | string | Alternative | *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) | null | Alternative | |
anchor_gid | JSON | Optional | |
anchor_gid (anyOf 1) | string | Alternative | *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) | null | Alternative | |
created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
created_by | Model | Optional | Expand Get users in a team — response body — data data item |
resource_subtype | string | Optional | 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. Read only: true |
text | string | Optional | *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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *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. |
gid | string | Required within parent | 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 |
Get users in a team — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
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 | *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
| 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. The computed actor responsible for the underlying activity, or `null` when no actor is available. 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 object. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]