Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AT Protocol notification API

Notification management

AT Protocol notification API is one of 9 APIs that AT Protocol publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include notification. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://public.api.bsky.app/xrpc, https://api.bsky.app/xrpc.

2 operations 2 paths 5 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://bsky.social/xrpc
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

AT Protocol notification API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated, though some operations may also be called without credentials.

  • bearerAuth — Access JWT obtained from com.atproto.server.createSession

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

notification 2

Notification management

GET
/app.bsky.notification.listNotifications
List Notifications
app_bsky_notification_listNotifications 5 params → 200400401
GET
/app.bsky.notification.getUnreadCount
Get Unread Count
app_bsky_notification_getUnreadCount 2 params → 200400401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ProfileView (10 properties), Notification (9 properties), ViewerState (8 properties), Label (8 properties). Each schema is shown below with its type and property counts.

Label
object
8 properties 4 required
Error
object
2 properties 2 required
ViewerState
object
Metadata about the relationship between the requesting account and the subject account.
8 properties
Notification
object
9 properties 7 required
ProfileView
object
10 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atproto-notification-api-openapi.yml Raw ↑

Other APIs AT Protocol publishes across the network.

AT Protocol Firehose (Event Stream)
AT Protocol actor API
AT Protocol feed API
AT Protocol graph API
AT Protocol identity API
AT Protocol repo API
AT Protocol server API
AT Protocol sync API