List notifications - Flow

GET

/

notifications

/

feed

cURL

curl --request GET \
  --url https://backend.branch.flowengineering.com/notifications/feed \
  --header 'X-API-Key: <api-key>' \
  --header 'customer: <customer>'

import requests

url = "https://backend.branch.flowengineering.com/notifications/feed"

headers = {
    "customer": "<customer>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {customer: '<customer>', 'X-API-Key': '<api-key>'}};

fetch('https://backend.branch.flowengineering.com/notifications/feed', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "created_at": "<string>",
      "event_type": "UserInvited",
      "id": "<string>",
      "payload": {},
      "read": true
    }
  ],
  "total": 123
}

Authorizations

X-API-Key

string

header

required

Headers

customer

string

required

Workspace identifier

Query Parameters

page

string

1-based page number (default 1)

limit

string

Page size (1-100, default 20)

project_id

string

required

Project scope (REQUIRED). The feed is always mounted under a project, so it must be scoped to one — the @CustomerApi guard then authorises the caller against this project. An omitted scope must NOT fall back to an all-projects read: that would return historical rows (incl. EntityChanged structured diffs) from projects the caller has since lost access to.

branch_id

string

Branch filter: 'master' for Base, a branch UUID, or omit for all

unread

string

When "true", only unread notifications

type

string

Type filter category: 'item' (entity updates), 'comments', 'reviews' (branch review lifecycle), or omit/'all' for every type

Response

200 - application/json

items

object[]

required

Show child attributes

total

number

required

Total matching rows across all pages

cURL

curl --request GET \
  --url https://backend.branch.flowengineering.com/notifications/feed \
  --header 'X-API-Key: <api-key>' \
  --header 'customer: <customer>'

import requests

url = "https://backend.branch.flowengineering.com/notifications/feed"

headers = {
    "customer": "<customer>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {customer: '<customer>', 'X-API-Key': '<api-key>'}};

fetch('https://backend.branch.flowengineering.com/notifications/feed', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "created_at": "<string>",
      "event_type": "UserInvited",
      "id": "<string>",
      "payload": {},
      "read": true
    }
  ],
  "total": 123
}