Skip to content

Asana: Notifications schemas

10 Asana schemas with complete fields and constraints.

← Notifications operations · All schemas

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 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.

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 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 notifications for a user — response body — data, next page data item story anchor gid, comment gid, created at, created by, gid, resource subtype, resource type, text anchor gid, comment gid, created at, created by, gid, resource subtype, resource type, text

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A 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 an OOO entry — response body — data data user
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 an OOO entry — response body — data data user

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 data item — sdk__Notification Response

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
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.
gidstringRequired within parentGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
priority_classificationstringOptionalThe notification's Priority classification.
Known values: unclassified
Read only: true
story_resource_subtypestringOptionalThe stable public subtype of the Story that produced the notification.
Read only: true
work_objectsarrayOptionalWork referenced by the notification. Each entry is a compact representation of the underlying Asana resource.
Read only: true
work_objects[]objectEach itemA generic Asana Resource, containing a globally unique identifier.
work_objects[].gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
work_objects[].resource_typestringOptionalThe base type of this resource.
Read only: true
work_objects[].namestringOptionalThe name of the object.
storyJSONOptional
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
story (anyOf 1) (allOf 1)ModelAll variants applyExpand Get notifications for a user — response body — data, next page data item story anchor gid, comment gid, created at, created by, gid, resource subtype, resource type, text anchor gid, comment gid, created at, created by, gid, resource subtype, resource type, text
story (anyOf 2)nullAlternative
created_byJSONOptional
created_by (anyOf 1)ModelAlternativeExpand Get notifications for a user — response body — data, next page data item created by gid, name, resource type
created_by (anyOf 2)nullAlternative
created_atstringOptionalThe time at which the notification was created.
Format: date-time
Read only: true
is_readbooleanOptionalWhether the notification is effectively read in the user's Inbox.
Read only: true

Referenced models: Get notifications for a user — response body — data, next page data item created by gid, name, resource type, Get notifications for a user — response body — data, next page data item story anchor gid, comment gid, created at, created by, gid, resource subtype, resource type, text anchor gid, comment gid, created at, created by, gid, resource subtype, resource type, text

Mark notifications as read — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
workspacestringRequired within parentGID of the workspace used to route the request.
notification_gidsarrayRequired within parentThe notifications to update. Between 1 and 50 GIDs may be supplied, and duplicate GIDs are ignored.
Minimum items: 1
Maximum items: 50
notification_gids[]stringEach itemThe `gid` of a notification.

Mark notifications as read — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Mark notifications as read — response body — data data

Referenced models: Mark notifications as read — response body — data data

Mark notifications as read — response body — data data

FieldTypePresenceDescription and constraints
$objectRoot
failed_gidsarrayOptionalThe GIDs from notification_gids that could not be updated, for example because the notification does not exist, does not belong to the caller, or has been deleted. GIDs not listed here were updated successfully. Empty when every GID succeeded.
failed_gids[]stringEach itemThe `gid` of a notification that failed to update.

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.