Sky5 Administrator API Documentation

Welcome to the comprehensive documentation for the Sky5 Administrator API search operations. This documentation provides everything you need to implement powerful search, filter, sort, and pagination functionality in your frontend applications.

What You'll Learn

  • Search Operations: Master all available search operators and their syntax

  • API Endpoints: Understand which endpoints support search functionality

  • Frontend Integration: Get ready-to-use code examples for your applications

  • Performance Optimization: Learn best practices for efficient queries

  • Security: Understand validation and security measures

Quick Start

The Sky5 Administrator API supports advanced search operations across multiple endpoints. All endpoints extending the ProjectionSearchService provide consistent search functionality.

Basic Example

GET /api/v0/accounts?name__like=john&balance__ge=1000&page=0&size=20

Supported Operations

  • eq - Equals

  • ne - Not equals

  • gt - Greater than

  • ge - Greater than or equal

  • lt - Less than

  • le - Less than or equal

  • like - Contains (case-insensitive)

  • in - In list

Navigation

Use the sidebar to navigate through different sections:

  • Start with Search Operations to understand the basics

  • Check API Endpoints for specific endpoint details

  • Review Usage Examples for practical implementations

  • Use Frontend Implementation for code integration

  • Refer to Troubleshooting when you encounter issues

API Base Information

  • Base URL: /api/v0

  • Authentication: Required for all endpoints

  • Response Format: JSON with consistent structure

  • Rate Limiting: Applied per user/IP

Ready to get started? Begin with the Basic Operations section!

PreviousTable of contentsNextGetting Started