dev.knotless.listNotifications

lexicons.knotless.dev

Documentation

What others did that concerns the account asking, as the appview has indexed it, the latest first: stars of its repositories, follows of it, pulls and issues opened on its repositories, comments and reviews on its pulls and issues, and on those it commented on, after it did, and pulls, issues and comments that mention it. One record is one notification: a comment that mentions the author of what it is on is heard of as a comment. Leaves out its own doings, and accounts it blocked or that are taken down. Those of a private repository come from the appview's own index of its space, where its owner lets it keep one, while the account can read it: a mention of someone who cannot is never heard of. Requires authentication: a service token, or the session cookie the pages' login sets.

main query

What others did that concerns the account asking, as the appview has indexed it, the latest first: stars of its repositories, follows of it, pulls and issues opened on its repositories, comments and reviews on its pulls and issues, and on those it commented on, after it did, and pulls, issues and comments that mention it. One record is one notification: a comment that mentions the author of what it is on is heard of as a comment. Leaves out its own doings, and accounts it blocked or that are taken down. Those of a private repository come from the appview's own index of its space, where its owner lets it keep one, while the account can read it: a mention of someone who cannot is never heard of. Requires authentication: a service token, or the session cookie the pages' login sets.

Parameters

cursor string Optional

Where the page before ended.

limit integer Optional

No description available.

Output

Encodingapplication/json
cursor string Optional

Absent on the last page.

notifications array Required

No description available.

seenAt stringdatetime Optional

When the account last said it had seen its notifications, if ever.

Errors

AuthenticationRequired No account asks.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Where the page before ended.
View raw schema 
{
  "description": "What others did that concerns the account asking, as the appview has indexed it, the latest first: stars of its repositories, follows of it, pulls and issues opened on its repositories, comments and reviews on its pulls and issues, and on those it commented on, after it did, and pulls, issues and comments that mention it. One record is one notification: a comment that mentions the author of what it is on is heard of as a comment. Leaves out its own doings, and accounts it blocked or that are taken down. Those of a private repository come from the appview's own index of its space, where its owner lets it keep one, while the account can read it: a mention of someone who cannot is never heard of. Requires authentication: a service token, or the session cookie the pages' login sets.",
  "errors": [
    {
      "description": "No account asks.",
      "name": "AuthenticationRequired"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "description": "Absent on the last page.",
          "type": "string"
        },
        "notifications": {
          "items": {
            "ref": "#notification",
            "type": "ref"
          },
          "type": "array"
        },
        "seenAt": {
          "description": "When the account last said it had seen its notifications, if ever.",
          "format": "datetime",
          "type": "string"
        }
      },
      "required": [
        "notifications"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cursor": {
        "description": "Where the page before ended.",
        "maxLength": 512,
        "type": "string"
      },
      "limit": {
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      }
    },
    "type": "params"
  },
  "type": "query"
}
notification object

One thing another account did that concerns the asker.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

isRead boolean Required

Whether it is from before the asker last saw its notifications.

reason string Required

What it did: starred the asker's repository, followed the asker, opened a pull or an issue on its repository, commented on its pull or issue, or on one it commented on, mentioned the asker in a pull, an issue or a comment, or asked it to review a pull that is not a draft.

Known values: star, follow, pull, issue, comment, mention, review-requested
reasonSubject string at-uri Optional

For a comment, or a mention in one, the pull or issue it is on.

title string Optional

The title of the pull or issue it is, or is on.

uri string at-uri Required

The record it wrote: a star, a follow, a pull, an issue or a comment, or the pull, issue or comment that mentions the asker.

verdict string Optional

For a comment that reviews a pull, what it found: `approve`, or `changes` to ask for changes.

Known values: approve, changes
View raw schema 
{
  "description": "One thing another account did that concerns the asker.",
  "properties": {
    "author": {
      "ref": "dev.knotless.defs#actorView",
      "type": "ref"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "isRead": {
      "description": "Whether it is from before the asker last saw its notifications.",
      "type": "boolean"
    },
    "reason": {
      "description": "What it did: starred the asker's repository, followed the asker, opened a pull or an issue on its repository, commented on its pull or issue, or on one it commented on, mentioned the asker in a pull, an issue or a comment, or asked it to review a pull that is not a draft.",
      "knownValues": [
        "star",
        "follow",
        "pull",
        "issue",
        "comment",
        "mention",
        "review-requested"
      ],
      "type": "string"
    },
    "reasonSubject": {
      "description": "For a comment, or a mention in one, the pull or issue it is on.",
      "format": "at-uri",
      "type": "string"
    },
    "repo": {
      "description": "The repository it is about, under the name it has now, if any.",
      "ref": "dev.knotless.defs#repoViewBasic",
      "type": "ref"
    },
    "title": {
      "description": "The title of the pull or issue it is, or is on.",
      "type": "string"
    },
    "uri": {
      "description": "The record it wrote: a star, a follow, a pull, an issue or a comment, or the pull, issue or comment that mentions the asker.",
      "format": "at-uri",
      "type": "string"
    },
    "verdict": {
      "description": "For a comment that reviews a pull, what it found: `approve`, or `changes` to ask for changes.",
      "knownValues": [
        "approve",
        "changes"
      ],
      "type": "string"
    }
  },
  "required": [
    "uri",
    "author",
    "reason",
    "isRead",
    "createdAt"
  ],
  "type": "object"
}

Lexicon Garden

@