Listing and Pagination

The orders endpoint allows you to retrieve your orders with support for pagination using an offset. This enables you to efficiently navigate through large sets of orders. The endpoint supports per_page and offset query parameters. To retrieve orders with pagination, you must provide a valid API key.

Retrieving a list of orders with a set per page limit

JavaScript

const apiKey = "YOUR_API_KEY";
const perPage = 16;

const getOrders = async (perPage, apiKey) => {
    const getOrdersResponse = await fetch(
      `https://api.autoenhance.ai/v3/orders?per_page=${perPage}`,
      { 
        method: "GET",
        headers:{
          "x-api-key": apiKey,  
        }
      }
    );

    const { orders, pagination } = await getOrdersResponse.json();
}

Python

import requests

api_key = "YOUR_API_KEY"
per_page = 16

def get_orders(per_page, api_key):
    url = f"https://api.autoenhance.ai/v3/orders?per_page={per_page}"
    headers = {
        "x-api-key": api_key
    }
    
    response = requests.get(url, headers=headers)
    response_data = response.json()
    
    orders = response_data.get('orders')
    pagination = response_data.get('pagination')
    
    return orders, pagination

PHP

$apiKey = "YOUR_API_KEY";
$perPage = 16;

function get_orders($perPage, $apiKey) {
    $url = "https://api.autoenhance.ai/v3/orders?per_page=$perPage";

    $options = array(
        'http' => array(
            'header'  => "Content-Type: application/json\r\n" .
                         "x-api-key: $apiKey",
            'method'  => 'GET'
        )
    );

    $context = stream_context_create($options);
    $result = file_get_contents($url, false, $context);

    if ($result === FALSE) {
        return 'Error fetching orders';
    }

    $orders_data = json_decode($result, true);
    return $orders_data;
}

cURL

curl -X GET \
  'https://api.autoenhance.ai/v3/orders?per_page=16' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY'

As you can see, the response returns an orders, and pagination object. The orders object contains the list of your orders, and pagination contains two values: per_page, and next_offset.

Retrieving a paginated list of orders

If you want to load more orders with a pagination (next batch of orders without the initial orders that you've already fetched), you will need to use the next_offset value in your next request.

The value next_offset is returned from in the object that is returned from retrieving a list of orders with a set per page limit

JavaScript

const apiKey = "YOUR_API_KEY";
const pagination = { per_page:16, next_offset:"string" };

const loadMoreOrders = async (perPage, nextOffset, apiKey) => {
    const loadMoreOrdersResponse = await fetch(
      `https://api.autoenhance.ai/v3/orders?per_page=${perPage}&offset=${nextOffset}`,
      { 
        method: "GET",
        headers:{
          "x-api-key": apiKey,  
        }
      }
    );

    const { orders, pagination } = await getOrdersResponse.json();
}

Python

import requests

api_key = "YOUR_API_KEY"
per_page = 16
next_offset = "string"

def load_more_orders(per_page, next_offset, api_key):
    url = f"https://api.autoenhance.ai/v3/orders?per_page={per_page}&offset={next_offset}"
    headers = {
        "x-api-key": api_key
    }
    
    response = requests.get(url, headers=headers)
    response_data = response.json()
    
    orders = response_data.get('orders')
    pagination = response_data.get('pagination')
    
    return orders, pagination

PHP

$apiKey = "YOUR_API_KEY";
$perPage = 16;
$nextOffset = "string";

function load_more_orders($perPage, $nextOffset, $apiKey) {
    $url = "https://api.autoenhance.ai/v3/orders?per_page=$perPage&offset=$nextOffset";

    $options = array(
        'http' => array(
            'header'  => "Content-Type: application/json\r\n" .
                         "x-api-key: $apiKey",
            'method'  => 'GET'
        )
    );

    $context = stream_context_create($options);
    $result = file_get_contents($url, false, $context);

    if ($result === FALSE) {
        return 'Error loading more orders';
    }

    $response_data = json_decode($result, true);
    return $response_data;
}

cURL

curl -X GET \
  'https://api.autoenhance.ai/v3/orders?per_page=16&offset=string' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY'

Important note The response will always return pagination object with values that will enable you to fetch next batch of orders if you still have more orders to fetch.

Specification

List Orders

get

Lists the orders for the current user with optional search and sorting.

Query Parameters:

• q: Free-text search term applied to order name
• sort: Sorting key (name, -name, date, -date). Defaults to -date (most recent first)
• offset: Pagination offset token
• per_page: Number of items per page

Authorizations

x-api-keystringRequired

Query parameters

offsetstringOptional

The offset token used to indicate which page of results to use.

Default: 0

per_pageinteger · max: 15Optional

The amount of items to be loaded per page of results. The final response may have a smaller number than requested if too large.

Default: 5

qstring · nullableOptional

Free-text search term applied to order name. If omitted or empty, no search filter is applied.

Default: null

sortstringOptional

Sorting key with optional '-' prefix for descending order. Allowed values: 'name' (sort by name ascending), '-name' (sort by name descending), 'date' (sort by created_at ascending), '-date' (sort by created_at descending). If omitted or invalid, defaults to '-date' (most recent first).

Default: -date

Responses

200

Successful response

application/json

401

Authentication error

application/json

422

Validation error

application/json

get/v3/orders/

GET /v3/orders/ HTTP/1.1
Host: api:8080
x-api-key: YOUR_API_KEY
Accept: */*

{
  "orders": [
    {
      "created_at": "2026-01-01T00:00:00.000Z",
      "default_image_sort_order": "name",
      "images": [
        {
          "ai_version": "text",
          "cloud_type": "CLEAR",
          "date_added": 1,
          "downloaded": true,
          "enhance": true,
          "enhance_type": "property",
          "finetune_settings": {},
          "image_id": "123e4567-e89b-12d3-a456-426614174000",
          "image_name": "text",
          "lens_correction": true,
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "order_id": null,
          "parent_image_id": "text",
          "preset_id": null,
          "preset_version": null,
          "privacy": true,
          "rating": 1,
          "restage": {
            "fire_in_fireplaces": "AS_SHOT",
            "grass": "AS_SHOT",
            "photographer": "AS_SHOT",
            "sky": "AS_SHOT",
            "tvs": "AS_SHOT"
          },
          "scene": "text",
          "sky_replacement": true,
          "status": null,
          "status_reason": null,
          "tripod_hide": true,
          "upscale": true,
          "user_id": null,
          "vertical_correction": true,
          "window_pull_type": "NONE",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "is_deleted": true,
      "is_merging": true,
      "is_processing": true,
      "last_updated_at": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "order_id": "text",
      "status": null,
      "total_images": 1
    }
  ],
  "pagination": {
    "next_offset": "text",
    "per_page": 5
  }
}