Rate this page:
GET /1/notifications/{id}
string
The ID of the notification
^[0-9a-fA-F]{24}$
boolean
Whether to include the board object
false
string
all
or a comma-separated list of board fields
form
Valid values: id
, name
, desc
, descData
, closed
, idMemberCreator
, idOrganization
, pinned
, url
, shortUrl
...(Show more)
boolean
Whether to include the card object
false
string
all
or a comma-separated list of card fields
form
Valid values: id
, address
, badges
, checkItemStates
, closed
, coordinates
, creationMethod
, dueComplete
, dateLastActivity
, desc
...(Show more)
boolean
Whether to include the display object with the results
false
boolean
Whether to include the entities object with the results
false
string
all
or a comma-separated list of notification fields
form
Valid values: id
, unread
, type
, date
, dateRead
, data
, card
, board
, idMemberCreator
, idAction
...(Show more)
boolean
Whether to include the list object
false
boolean
Whether to include the member object
true
string
all
or a comma-separated list of member fields
form
Valid values: id
boolean
Whether to include the member object of the creator
true
string
all
or a comma-separated list of member fields
Valid values: id
boolean
Whether to include the organization object
false
string
all
or a comma-separated list of organization fields
Valid values: id
, name
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/notifications/{id}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
PUT /1/notifications/{id}
Update the read status of a notification
string
The ID of the notification
^[0-9a-fA-F]{24}$
boolean
Whether the notification should be marked as read or not
1 2 3
curl --request PUT \
--url 'https://api.trello.com/1/notifications/{id}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/notifications/{id}/{field}
Get a specific property of a notification
string
The ID of the notification
^[0-9a-fA-F]{24}$
string
A notification field
Valid values: id
, unread
, type
, date
, dateRead
, data
, card
, board
, idMemberCreator
, idAction
...(Show more)
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/notifications/{id}/{field}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
POST /1/notifications/all/read
Mark all notifications as read
boolean
Boolean to specify whether to mark as read or unread (defaults to true
, marking as read)
true
Array<string>
A comma-seperated list of IDs. Allows specifying an array of notification IDs to change the read state for. This will become useful as we add grouping of notifications to the UI, with a single button to mark all notifications in the group as read/unread.
form
1 2 3
curl --request POST \
--url 'https://api.trello.com/1/notifications/all/read?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
PUT /1/notifications/{id}/unread
Update Notification's read status
string
The ID of the notification
^[0-9a-fA-F]{24}$
string
1 2 3
curl --request PUT \
--url 'https://api.trello.com/1/notifications/{id}/unread?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/notifications/{id}/board
Get the board a notification is associated with
string
The ID of the notification
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of boardfields
form
Valid values: id
, name
, desc
, descData
, closed
, idMemberCreator
, idOrganization
, pinned
, url
, shortUrl
...(Show more)
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/notifications/{id}/board?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/notifications/{id}/card
Get the card a notification is associated with
string
The ID of the notification
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of card fields
form
Valid values: id
, address
, badges
, checkItemStates
, closed
, coordinates
, creationMethod
, dueComplete
, dateLastActivity
, desc
...(Show more)
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/notifications/{id}/card?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/notifications/{id}/list
Get the list a notification is associated with
string
The ID of the notification
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of list fields
Valid values: id
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/notifications/{id}/list?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/notifications/{id}/member
Get the member (not the creator) a notification is about
string
The ID of the notification
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of member fields
Valid values: id
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/notifications/{id}/member?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/notifications/{id}/memberCreator
Get the member who created the notification
string
The ID of the notification
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of member fields
form
Valid values: id
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/notifications/{id}/memberCreator?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/notifications/{id}/organization
Get the organization a notification is associated with
string
The ID of the notification
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of organization fields
form
Valid values: id
, name
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/notifications/{id}/organization?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
Rate this page: