Service API

GraphQL API for Haltian IoT device management and data access

Overview

Use the Service API to fetch device inventories, query measurement history, and manage device configuration from your backend application. It is a GraphQL API — you send queries to retrieve exactly the data you need, and mutations to perform actions like updating device settings.

Your Service API endpoint and credentials are provided during onboarding.

Key Characteristics

  • Capabilities: Read queries and write mutations
  • Best for: Backend integrations, on-demand data retrieval, device management automation

Usage Guidance

The Service API is designed for on-demand, user-initiated interactions — for example, loading a device list when a user opens a dashboard, or updating a configuration when an operator makes a change.

It is not intended for continuous polling, scheduled automated queries, or periodic health-check scripts. If you need ongoing data delivery, use the Stream API for real-time events or the Data API for regular bulk exports — both are purpose-built for automated consumption without placing unnecessary load on the platform.

In This Section

  • Authentication - Login, token refresh, and API key management
  • Queries - Device, measurement, organization, and asset queries
  • Mutations - Device configuration and management operations

Authentication

GraphQL API authentication - login, token refresh, and authorization

Queries

GraphQL queries for devices, measurements, spaces, and assets

Mutations

GraphQL mutations for device configuration and management