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

The Things Network / The Things Stack NotificationService API

The NotificationService API from The Things Network / The Things Stack — 1 operation(s) for notificationservice.

The Things Network / The Things Stack NotificationService API is one of 58 APIs that The Things Network / The Things Stack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include NotificationService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.

This API exposes 2 operations across 1 path, and defines 14 schemas. It is described by OpenAPI 2.0, at version v3.36.

2 operations 1 paths 14 schemas 1 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v3.36
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

The Things Network / The Things Stack NotificationService API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Bearer API key. Set Authorization: Bearer NNSXS.xxxxxxxxxx.

Paths & Operations 2

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

NotificationService 2
GET
/users/{receiver_ids.user_id}/notifications
List the notifications for a user or an organization. When called with user credentials and empty receiverids, this will list notifications for the current user and its organizations.
NotificationService_List 5 params → 200default
PATCH
/users/{receiver_ids.user_id}/notifications
Batch-update multiple notifications to the same status.
NotificationService_UpdateStatus 2 params → 200default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are v3Notification (10 properties), v3EntityIdentifiers (6 properties), v3EndDeviceIdentifiers (5 properties), googlerpcStatus (3 properties). Each schema is shown below with its type and property counts.

v3NotificationStatus
string
googlerpcStatus
object
3 properties
v3EntityIdentifiers
object
EntityIdentifiers contains one of the possible entity identifiers.
6 properties
v3ListNotificationsResponse
object
1 property
NotificationServiceUpdateStatusBody
object
3 properties
v3EndDeviceIdentifiers
object
5 properties
v3ApplicationIdentifiers
object
1 property
lorawanv3GatewayIdentifiers
object
2 properties
v3UserIdentifiers
object
2 properties
v3Notification
object
10 properties
v3NotificationReceiver
string
- NOTIFICATIONRECEIVERCOLLABORATOR: Notification is received by collaborators of the entity. If the collaborator is an organization, the notification is receiv…
v3ClientIdentifiers
object
1 property
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
v3OrganizationIdentifiers
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-things-network-notificationservice-api-openapi.yml Raw ↑

Other APIs The Things Network / The Things Stack publishes across the network.

The Things Network / The Things Stack AppAs API
The Things Network / The Things Stack ApplicationAccess API
The Things Network / The Things Stack ApplicationActivationSettingRegistry API
The Things Network / The Things Stack ApplicationPackageRegistry API
The Things Network / The Things Stack ApplicationPubSubRegistry API
The Things Network / The Things Stack ApplicationRegistry API
The Things Network / The Things Stack ApplicationUpStorage API
The Things Network / The Things Stack ApplicationWebhookRegistry API
The Things Network / The Things Stack As API
The Things Network / The Things Stack AsEndDeviceBatchRegistry API
The Things Network / The Things Stack AsEndDeviceRegistry API
The Things Network / The Things Stack ClientAccess API