Get the unread notification count - Spacefast Docs

Get the unread notification count

Returns how many of the signed-in user’s notifications have no readAt. Only a dashboard session can call this.

GET /v1/notifications/unread-count

Authorization

Authorization Bearer token · header required

nAuthorization: Bearer <token> with an API key (sfa_ prefix), an OAuth access token, a session token, or a Space machine credential (sfm_ prefix).

Responses

200 Response for status 200

$schema string

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

data object required
Show properties
Hide properties

count integer required
How many of the user's notifications have no readAt.

min 0 · max 9007199254740991

default Error. Every 4xx and 5xx response is one RFC 9457 problem document served as application/problem+json.

$schema string

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

type string required

URL of the documentation page for this error. Derived from code.

title string required

Human-readable name of the error type. Derived from code.

status integer required

HTTP status of the response, repeated in the body.

min -9007199254740991 · max 9007199254740991

detail string required

What went wrong in this request.

code string required

Stable snake_case error code. Match on this, not on detail.

pointer string

RFC 6901 JSON Pointer to the request field or batch entry that failed, for example /files/37/path. Present on validation failures.

details object

Machine-readable context keyed by the error code.

suggestions string[]

Recovery steps safe to show to a person.

next string[]

Commands or API requests to run next, usable as written.

requestId string required

ID of this request, from the X-Request-Id header or generated. Quote it when contacting support.

Try it

Server

Base URL https://api.spacefast.com
Custom base URL Overrides the selected server when set.

Authorization

Bearer token
Remember on this device
Include my values in samples

Request Examples

cURL

curl -X GET "https://api.spacefast.com/v1/notifications/unread-count" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://api.spacefast.com/v1/notifications/unread-count", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Python

import requests

response = requests.get(
    "https://api.spacefast.com/v1/notifications/unread-count",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

200 Default

{
  "$schema": "http://example.com",
  "data": {
    "count": 9007199254740991
  }
}
{
  "$schema": "http://example.com",
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "pointer": "string",
  "details": {
    "property1": null,
    "property2": null
  },
  "suggestions": [
    "string"
  ],
  "next": [
    "string"
  ],
  "requestId": "string"
}