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

Parameters

Parameter Required Data Type Description
api_key Yes String App Group REST API Key
page No Integer The page of cards to return, defaults to 0 (returns the first set of up to 100)
include_archived No Boolean Whether or not to include archived cards, defaults to false
sort_direction No String Pass in the value desc to sort by creation time from newest to oldest. Pass in asc to sort from oldest to newest. If sort_direction is not included, the default order is oldest to newest.

Example URL

https://rest.iad-01.braze.com/feed/list?api_key=75480f9a-4db8-4057-8b7e-4d59bfd73709&page=1&include_archived=true

Response

Content-Type: application/json

1
2
3
4
5
6
7
8
9
10
11
12
13
Content-Type: application/json
{
    "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 or DevPick (cross-promotional cards),
            "title" : (string) title of the card,
            "tags" : (array) tag names associated with the card
        },
        ...
    ]
}
WAS THIS PAGE HELPFUL?
New Stuff!