The Things Network / The Things Stack EntityRegistrySearch 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 EntityRegistrySearch. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.
This API exposes
10 operations
across 10 paths,
and defines 45 schemas.
It is described by OpenAPI 2.0, at version v3.36.
10 operations10 paths45 schemas10 GET
Metadata
The identity and technical contract details declared by the specification.
The Things Network / The Things Stack EntityRegistrySearch 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 10
Across 10 paths, the API surfaces 10 operations — 10 GET. Each is listed below with its method, path, parameters, and response codes.
The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are v3Gateway (31 properties), v3User (23 properties), v3Client (19 properties), v3Application (14 properties). Each schema is shown below with its type and property counts.
UserConsolePreferencesSortBy
object
SortBy defines the field to which the Console will sort the display of entities.
7 properties
v3ConsoleTheme
string
ConsoleTheme is the theme of the Console. - CONSOLETHEMESYSTEM: The user prefers the system mode. - CONSOLETHEMELIGHT: The user prefers the light mode. - CONSO…
v3ContactMethod
string
v3LocationSource
string
- SOURCEUNKNOWN: The source of the location is not known or not set. - SOURCEGPS: The location is determined by GPS. - SOURCEREGISTRY: The location is set in a…
v3User
object
User is the message that defines a user on the network.
23 properties
PictureEmbedded
object
2 properties
v3ContactType
string
lorawanv3GatewayIdentifiers
object
2 properties
v3Client
object
An OAuth client on the network.
19 properties
v3GatewayAntenna
object
GatewayAntenna is the message that defines a gateway antenna.
4 properties
v3SearchAccountsResponse
object
1 property
v3EmailNotificationPreferences
object
EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.
1 property
v3GatewayClaimAuthenticationCode
object
Authentication code for claiming gateways.
3 properties
v3Application
object
Application is the message that defines an Application in the network.
14 properties
lorawanv3Location
object
5 properties
GatewayLRFHSS
object
LR-FHSS gateway capabilities.
1 property
UserConsolePreferencesDashboardLayouts
object
8 properties
UserConsolePreferencesTutorials
object
1 property
v3OrganizationOrUserIdentifiers
object
OrganizationOrUserIdentifiers contains either organization or user identifiers.
2 properties
v3UserConsolePreferences
object
UserConsolePreferences is the message that defines the user preferences for the Console.
4 properties
v3Users
object
1 property
v3Right
string
Right is the enum that defines all the different rights to do something in the network. - RIGHTUSERINFO: The right to view user information. - RIGHTUSERSETTING…
v3ApplicationIdentifiers
object
1 property
v3Secret
object
Secret contains a secret value. It also contains the ID of the Encryption key used to encrypt it.
2 properties
v3Organizations
object
1 property
v3Applications
object
1 property
v3DownlinkPathConstraint
string
- DOWNLINKPATHCONSTRAINTNONE: Indicates that the gateway can be selected for downlink without constraints by the Network Server. - DOWNLINKPATHCONSTRAINTPREFER…
v3GrantType
string
The OAuth2 flows an OAuth client can use to get an access token. - GRANTAUTHORIZATIONCODE: Grant type used to exchange an authorization code for an access toke…
v3ClientIdentifiers
object
1 property
v3NotificationType
string
v3Tutorial
string
Tutorial is a set of possible tutorials in the Console.
v3OrganizationIdentifiers
object
1 property
v3Organization
object
11 properties
v3Gateway
object
Gateway is the message that defines a gateway on the network.
31 properties
v3DashboardLayout
string
DashboardLayout is a set of possible layout values to be used in the Console.
googlerpcStatus
object
3 properties
v3Clients
object
1 property
v3GatewayAntennaPlacement
string
v3Gateways
object
1 property
v3UserIdentifiers
object
2 properties
v3State
string
State enum defines states that an entity can be in. - STATEREQUESTED: Denotes that the entity has been requested and is pending review by an admin. - STATEAPPR…
v3ContactInfo
object
5 properties
v3Picture
object
2 properties
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
v3GatewayVersionIdentifiers
object
Identifies an end device model with version information.
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
