Getting Started

Overview

The Sky5 Administrator API provides comprehensive search, filter, sort, and pagination operations across all endpoints that extend the ProjectionSearchService. This powerful system allows you to build complex queries with minimal effort.

Authentication

All API endpoints require proper authentication. Make sure you have:

• Valid authentication token

• Appropriate permissions for the endpoint you're accessing

Base URL

All API requests should be made to:

https://your-domain.com/api/v0

Response Format

All endpoints return responses in this consistent format:

{
  "message": "Data fetched successfully",
  "data": [...],
  "currentPage": 0,
  "totalItems": 150,
  "totalPages": 8
}

Quick Example

Here's a simple search query to get you started:

GET /api/v0/accounts?name__like=john&balance__ge=1000

This query finds all accounts where:

• Name contains "john" (case-insensitive)

• Balance is greater than or equal to 1000

Next Steps

1. Learn about Basic Operations

2. Explore Field Types

3. Check out Usage Examples