Skip to main content
GET
/
api
/
v2
/
feeds
List feeds
curl --request GET \
  --url https://app.octolens.com/api/v2/feeds \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 0,
      "name": "Competitor mentions",
      "icon": "BellIcon",
      "simpleFilters": {
        "conditions": [
          {
            "field": "Keywords",
            "values": "42,43"
          }
        ]
      },
      "advancedFilters": {
        "groups": [
          {
            "conditions": [
              {
                "field": "<string>",
                "values": "42,43"
              }
            ],
            "isSingleCondition": true
          }
        ]
      },
      "isDefault": true,
      "destinations": [
        {
          "time": "09:00",
          "timezone": "UTC",
          "dayOfWeek": 3,
          "emailDestination": {
            "emails": "alice@example.com, bob@example.com"
          },
          "slackDestination": {
            "channels": "<string>",
            "channelNamesMap": "<string>"
          },
          "webhookDestination": {
            "url": "https://example.com/webhook"
          }
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>.

Query Parameters

​
excludeWithNotifications
boolean

When true, omits feeds that already have a notification destination attached. Useful for surfacing feeds that exist but aren't wired up to email/Slack/webhook yet.

Example:

true

Response

200 response

List of feeds for the authenticated organization.

​
data
object[]
required