Feeds

Feeds are used to collect posts across a number of social media networks into a single channel that can be integrated into a widget, displayed on your website, displayed on a digital TV, queried via an API, etc, et cetera, and so forth.

---

Methods
List Feeds
Create Feed
Update Feed
Delete Feed

---

List Feeds

Returns a list of the Feeds

GET /feeds

Request

GET /v1/feeds

Response

[
  {
    "id": "660b923a-a6e7-4540-bd03-7e08fd006e0d",
    "public_key": "adfdad0b-88ea-4660-8fc5-6ab02741",
    "api_id": "6934ace4-4873-4b9f-b9c0-f72aa3ff41d6",
    "name": "Default feed",
    "type": "website",
    "widget_type": "Stack",
    "widget_theme": "sydney",
    "slug": "curator-feed",
    "moderation": "post",
    "post_status": 1,
    "widget_options": "{\"type\":\"Waterfall\"}",
    "widget_styles": "{}",
    "widget_colours": "{}",
    "widget_advanced_styles": 0,
    "colour_options": null,
    "meta": {
        "embedSource": "wordpress-plugin",
        "hasTiktokEmbed": true
    },
    "default_image": null,
    "default_user_image": null,
    "widget_endpoint": null,
    "debug": 0,
    "widget_version": "5.0",
    "js_loader_version": "2",
    "html_before": null,
    "html_after": null,
    "cache": 1,
    "cache_time": 60,
    "default_feed_layout_id": 143013,
    "post_count": 400,
    "is_installed": 1,
    "is_latest_version": true
}
]

---

Create Feed

Creates a Feed

POST /feeds

Request

POST /v1/feeds

{
    "name": "My feed"
}

Response

{
    "name": "My feed",
    "id": "315181d5-4f15-40bc-b2a0-0dd196caa13a",
    "public_key": "0b3057fb-80c3-4c0f-8af8-590274dbfbd0",
    "api_id": "8bdd8ca4-c5yj-4671-a16b-a0e3f78127db",
    "moderation": "post",
    "widget_version": "5.0",
    "widget_type": "Waterfall",
    "widget_theme": "sydney",
    "widget_styles": "{}",
    "widget_colours": "{}",
    "js_loader_version": "2",
    "debug": false,
    "cache": 1,
    "cache_time": 5,
    "slug": "curator-feed-my-feed",
    "default_feed_layout_id": 9914,
    "is_latest_version": true
}

Params

Param	Description	Required
name	Internal name of the Feed	Yes

---

Update Feed

Update a Feed

POST /feeds/FEED_ID

Request

POST /v1/feeds/FEED_ID

{
    "id": "315181d5-4f15-40bc-b2a0-0dd196caa13a",
    "public_key": "0b3057fb-80c3-4c0f-8af8-590274dbfbd0",
    "api_id": "8bdd8ca4-c5yj-4671-a16b-a0e3f78127db",
    "name": "My feed 2",
    "type": "website",
    "widget_type": "Waterfall",
    "widget_theme": "sydney",
    "slug": "curator-feed-my-feed",
    "moderation": "post",
    "post_status": 1,
    "widget_options": "{\"type\":\"Waterfall\"}",
    "widget_styles": "{}",
    "widget_colours": "{}",
    "widget_advanced_styles": 0,
    "colour_options": null,
    "meta": null,
    "default_image": null,
    "default_user_image": null,
    "widget_endpoint": null,
    "debug": 0,
    "widget_version": "5.0",
    "js_loader_version": "2",
    "html_before": null,
    "html_after": null,
    "cache": 1,
    "cache_time": 5,
    "default_feed_layout_id": 168486,
    "post_count": 0,
    "is_installed": 0,
    "is_latest_version": true
}

Response

{
  "id": "705da60d-4479-4696-b49b-29bca98d920d",
  "name": "Default",
  "moderation": "post",
  "colour_body_bg": "#efefef",
  "colour_body_text": "#707070",
  "colour_header_bg": "#efefef",
  "colour_header_text": "#2B2B2B",
  "public_key": "19c614db-c1d1-4111-af53-82f3765a"
}

Params

Param	Description
FEED_ID	Id of Feed to update
name	Name of feed - only displayed in the admin
moderation	Moderation the feed will use - post or pre
colour_body_bg	Body background colour to use for widget
colour_body_text	Body text color to use for widget
colour_header_bg	Header background colour to use for widget
colour_header_text	Header text colour to use for widget

---

Delete Feed

Removes a Feed.

Note: Deleting a feed will remove all associated sources and posts.

DELETE /feeds/FEED_ID

Request

DELETE /v1/feeds/FEED_ID

Response

{
  "success": true,
  "message": "Feed deleted"
}

Params

Param	Description	Required
FEED_ID	ID of Feed to delete	Yes

Feed cache TTL

Feed cache is based on the company plan update interval

{
  "cache": {
    "status": "hit",
    "key": "/v1/feeds/123456-1234-1234-1234-1234567890",
    "time": 10
  }
}