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
| 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 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. |
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 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 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
| 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. 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 an OOO entry — response body — data data user |
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 an OOO entry — response body — data data user
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 data item — sdk__Notification Response
| 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. 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 |
priority_classification | string | Optional | The notification's Priority classification. Known values: unclassified Read only: true |
story_resource_subtype | string | Optional | The stable public subtype of the Story that produced the notification. Read only: true |
work_objects | array | Optional | Work referenced by the notification. Each entry is a compact representation of the underlying Asana resource. Read only: true |
work_objects[] | object | Each item | A generic Asana Resource, containing a globally unique identifier. |
work_objects[].gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
work_objects[].resource_type | string | Optional | The base type of this resource. Read only: true |
work_objects[].name | string | Optional | The name of the object. |
story | JSON | Optional | |
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 |
story (anyOf 1) (allOf 1) | Model | All variants apply | Expand 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) | null | Alternative | |
created_by | JSON | Optional | |
created_by (anyOf 1) | Model | Alternative | Expand Get notifications for a user — response body — data, next page data item created by gid, name, resource type |
created_by (anyOf 2) | null | Alternative | |
created_at | string | Optional | The time at which the notification was created. Format: date-time Read only: true |
is_read | boolean | Optional | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
workspace | string | Required within parent | GID of the workspace used to route the request. |
notification_gids | array | Required within parent | The notifications to update. Between 1 and 50 GIDs may be supplied, and duplicate GIDs are ignored. Minimum items: 1 Maximum items: 50 |
notification_gids[] | string | Each item | The `gid` of a notification. |
Mark notifications as read — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
failed_gids | array | Optional | The 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[] | string | Each item | The `gid` of a notification that failed to update. |