News Feed Cards List Endpoint

get

/feed/list

This endpoint allows you to export a list of News Feed cards, each of which will include its name and Card API Identifier. The cards are returned in groups of 100 sorted by time of creation (oldest to newest by default).

Request Parameters

Parameter Required Data Type Description
page Optional Integer The page of cards to return, defaults to 0 (returns the first set of up to 100).
include_archived Optional Boolean Whether or not to include archived cards, defaults to false.
sort_direction Optional String - Sort creation time from newest to oldest: pass in the value desc.
- Sort creation time from oldest to newest: pass in the value asc.

If sort_direction is not included, the default order is oldest to newest.

Example Request

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/feed/list?page=1&include_archived=true&sort_direction=desc' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "cards" : [
        {
            "id" : (string) Card API Identifier,
            "type" : (string) type of the card - NewsItem (classic cards), CaptionedImage, Banner
            "title" : (string) title of the card,
            "tags" : (array) tag names associated with the card
        },
        ...
    ]
}
WAS THIS PAGE HELPFUL?
New Stuff!