Skip to main content

GraphQL API

danger

The GraphQL API is unstable and may change at any time. Direct querying of the GraphQL API is strongly discouraged and may be disabled entirely in the future.

Authentication​

Admin user authentication​

Admin users authenticate via the Local Public admin website using a username and password.

API user authentication​

API users are assigned and associated with exactly one station. See HTTP API - API Auth for information about how to obtain a token.

Categories​

The Local Public GraphQL API is organized in to five categories.

Admin API​

Authentication

Requires admin user authentication.

API operations for the Local Public admin website.

Consumer API​

Authentication

Requires API user authentication.

API operations used by consumer API users.

Public API​

API operations that do not require authentication.

References​

All other GraphQL objects (types, scalars, enums, etc.).

Shared API​

Authentication

Requires admin or API user authentication.

API operations used by both the admin website and consumer API users.