Return a user's homepage feed

Request

Provides a user’s homepage feed, complete with the homepage banner, user’s shortcuts and modules.

This is a restricted endpoint that requires enablement. Reach out to your Firstup representative for access.

Security

oauth2_as_a_user(Required scopes: feeds.read)

curl -i -X GET \
  https://partner.socialchorus.com/v2/feeds/web_homepage \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json

dataobject(Feeds.WebHomepage.Resource)required

A user's assembled custom homepage. The feed array contains an ordered list of modules. Each module has a type and an attributes object whose shape depends on the module type (banner, link_carousel, or a content module: hero, grid, gallery, row). Content modules embed their resolved feed_items.

Example:

{
  "type": "web_homepage",
  "attributes": {
    "id": "1f2e3d4c-5b6a-7980-1234-567890abcdef",
    "feed": [ … ]
  }
}

Response

{
  "data": {
    "type": "web_homepage",
    "attributes": { … }
  }
}