Actions
    Applications
    Batch
    Boards
    Cards
    Checklists
    CustomFields
    Emoji
    Enterprises
    Labels
    Lists
    Members
    Notifications
    Organizations
    Plugins
    Search
    Tokens
    Webhooks

    Rate this page:

    Notifications

    Get a Notification

    GET /1/notifications/{id}

    Request

    Path parameters
    id Required

    string

    The ID of the notification

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    board

    boolean

    Whether to include the board object

    Default: false
    board_fields

    string

    all or a comma-separated list of board fields

    Style: form

    Valid values: id, name, desc, descData, closed, idMemberCreator, idOrganization, pinned, url, shortUrl ...(Show more)

    card

    boolean

    Whether to include the card object

    Default: false
    card_fields

    string

    all or a comma-separated list of card fields

    Style: form

    Valid values: id, address, badges, checkItemStates, closed, coordinates, creationMethod, dueComplete, dateLastActivity, desc ...(Show more)

    display

    boolean

    Whether to include the display object with the results

    Default: false
    entities

    boolean

    Whether to include the entities object with the results

    Default: false
    fields

    string

    all or a comma-separated list of notification fields

    Style: form

    Valid values: id, unread, type, date, dateRead, data, card, board, idMemberCreator, idAction ...(Show more)

    list

    boolean

    Whether to include the list object

    Default: false
    member

    boolean

    Whether to include the member object

    Default: true
    member_fields

    string

    all or a comma-separated list of member fields

    Style: form

    Valid values: id

    memberCreator

    boolean

    Whether to include the member object of the creator

    Default: true
    memberCreator_fields

    string

    all or a comma-separated list of member fields

    Valid values: id

    organization

    boolean

    Whether to include the organization object

    Default: false
    organization_fields

    string

    all or a comma-separated list of organization fields

    Valid values: id, name

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://api.trello.com/1/notifications/{id}' \
      --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Notification

    Update a Notification's read status

    PUT /1/notifications/{id}

    Update the read status of a notification

    Request

    Path parameters
    id Required

    string

    The ID of the notification

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    unread

    boolean

    Whether the notification should be marked as read or not

    Example

    1
    2
    3
    curl --request PUT \
      --url 'https://api.trello.com/1/notifications/{id}' \
      --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Notification

    Get a field of a Notification

    GET /1/notifications/{id}/{field}

    Get a specific property of a notification

    Request

    Path parameters
    id Required

    string

    The ID of the notification

    Pattern: ^[0-9a-fA-F]{24}$
    field Required

    string

    A notification field

    Valid values: id, unread, type, date, dateRead, data, card, board, idMemberCreator, idAction ...(Show more)

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://api.trello.com/1/notifications/{id}/{field}' \
      --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Notification

    Mark all Notifications as read

    POST /1/notifications/all/read

    Mark all notifications as read

    Request

    Query parameters
    read

    boolean

    Boolean to specify whether to mark as read or unread (defaults to true, marking as read)

    Default: true
    ids

    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.

    Style: form

    Example

    1
    2
    3
    curl --request POST \
      --url 'https://api.trello.com/1/notifications/all/read' \
      --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Notification

    Update Notification's read status

    PUT /1/notifications/{id}/unread

    Update Notification's read status

    Request

    Path parameters
    id Required

    string

    The ID of the notification

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    value

    string

    Example

    1
    2
    3
    curl --request PUT \
      --url 'https://api.trello.com/1/notifications/{id}/unread' \
      --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Notification

    Get the Board a Notification is on

    GET /1/notifications/{id}/board

    Get the board a notification is associated with

    Request

    Path parameters
    id Required

    string

    The ID of the notification

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    fields

    string

    all or a comma-separated list of boardfields

    Style: form

    Valid values: id, name, desc, descData, closed, idMemberCreator, idOrganization, pinned, url, shortUrl ...(Show more)

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://api.trello.com/1/notifications/{id}/board' \
      --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Board

    Get the Card a Notification is on

    GET /1/notifications/{id}/card

    Get the card a notification is associated with

    Request

    Path parameters
    id Required

    string

    The ID of the notification

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    fields

    string

    all or a comma-separated list of card fields

    Style: form

    Valid values: id, address, badges, checkItemStates, closed, coordinates, creationMethod, dueComplete, dateLastActivity, desc ...(Show more)

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://api.trello.com/1/notifications/{id}/card' \
      --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Card

    Get the List a Notification is on

    GET /1/notifications/{id}/list

    Get the list a notification is associated with

    Request

    Path parameters
    id Required

    string

    The ID of the notification

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    fields

    string

    all or a comma-separated list of list fields

    Valid values: id

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://api.trello.com/1/notifications/{id}/list' \
      --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    TrelloList

    Get the Member a Notification is about (not the creator)

    GET /1/notifications/{id}/member

    Get the member (not the creator) a notification is about

    Request

    Path parameters
    id Required

    string

    The ID of the notification

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    fields

    string

    all or a comma-separated list of member fields

    Valid values: id

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://api.trello.com/1/notifications/{id}/member' \
      --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Member

    Get the Member who created the Notification

    GET /1/notifications/{id}/memberCreator

    Get the member who created the notification

    Request

    Path parameters
    id Required

    string

    The ID of the notification

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    fields

    string

    all or a comma-separated list of member fields

    Style: form

    Valid values: id

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://api.trello.com/1/notifications/{id}/memberCreator' \
      --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Member

    Get a Notification's associated Organization

    GET /1/notifications/{id}/organization

    Get the organization a notification is associated with

    Request

    Path parameters
    id Required

    string

    The ID of the notification

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    fields

    string

    all or a comma-separated list of organization fields

    Style: form

    Valid values: id, name

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://api.trello.com/1/notifications/{id}/organization' \
      --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Organization

    Rate this page: