qqq

API Documentation

REST API reference for qqq applications

Overview

qqq applications automatically expose REST APIs for all tables and processes. This reference covers the standard API patterns.

Base URL

APIs are served from:

Text
https://your-app.example.com/api/v1

Authentication

Include authentication token in headers:

Text
Authorization: Bearer <token>

Table Endpoints

Query Records

HTTP
GET /api/v1/table/{tableName}/query

Query parameters:

  • filter - JSON filter object
  • orderBy - Sort field
  • limit - Max records (default 50)
  • offset - Pagination offset

    • Example:

    Bash
    curl -X GET 'https://app.example.com/api/v1/table/order/query?limit=10' \
  -H 'Authorization: Bearer <token>'

    Get Record

    HTTP
    GET /api/v1/table/{tableName}/{id}

    Insert Record

    HTTP
    POST /api/v1/table/{tableName}/insert
Content-Type: application/json

{"field1": "value1", "field2": "value2"}

    Update Record

    HTTP
    PATCH /api/v1/table/{tableName}/{id}
Content-Type: application/json

{"field1": "newValue"}

    Delete Record

    HTTP
    DELETE /api/v1/table/{tableName}/{id}

    Process Endpoints

    Run Process

    HTTP
    POST /api/v1/process/{processName}/run
Content-Type: application/json

{"input1": "value1"}

    Check Process Status

    HTTP
    GET /api/v1/process/{processName}/status/{runId}

    Response Format

    All responses follow this structure:

    JSON
    {
  "success": true,
  "data": { ... },
  "errors": []
}

    Error Codes

    Powered by qqq