index - nself-org/cli GitHub Wiki

API Documentation

Complete API reference for all nself APIs and integrations.


Overview

nself provides multiple APIs for accessing your backend services, including GraphQL, REST, and plugin-specific APIs.


API Documentation

Complete Reference

GraphQL API

  • GraphQL Overview - Hasura GraphQL Engine documentation
  • Auto-generated from your database schema
  • Real-time subscriptions
  • Role-based access control

REST APIs

API Documentation
Billing API Billing API Reference
White-Label API White-Label API Reference

Plugin APIs

Plugin-specific APIs are documented in each plugin's documentation:


Quick Start

GraphQL API

# Access GraphQL console
open https://api.local.nself.org

# Generate TypeScript types
nself db types

Authentication

# Get auth endpoints
nself urls auth

# Test authentication
curl https://auth.local.nself.org/healthz

Related Documentation


← Back to Documentation

⚠️ **GitHub.com Fallback** ⚠️