Scheduler Status API

Overview

The Scheduler Status API provides visibility into the data synchronization tasks that keep the platform's data up to date. You can use this API to check when data was last synchronized and whether sync tasks completed successfully.

Note: This API provides read-only access to task status information. All scheduled tasks are managed and executed automatically by the system.

Base Endpoint: /api/scheduler

API Endpoints

1. List All Registered Tasks

Retrieve a list of all registered scheduled task names.

Endpoint: GET /api/scheduler/tasks

Request:

curl "https://api.alaikis.com/std/api/scheduler/tasks" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

Response:

{
  "code": 200,
  "msg": "Request successful",
  "data": [
    "china-tax-sync",
    "eu-vat-sync",
    "gst-sales-tax-sync",
    "hs-code-sync",
    "oecd-corporate-tax-sync",
    "postcode-sync",
    "un-numbers-sync",
    "wikipedia-vat-sync"
  ]
}

---

2. Get Task Status

Retrieve the current execution status of a specific task.

Endpoint: GET /api/scheduler/status/taskName}

Parameters:

Parameter	Type	Required	Description
taskName	String	Yes	Task name

Request:

curl "https://api.alaikis.com/std/api/scheduler/status/eu-vat-sync" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

Response:

{
  "code": 200,
  "msg": "Request successful",
  "data": "SUCCESS"
}

Status Values:

Status	Description
RUNNING	Task is currently executing
SUCCESS	Task completed successfully
FAILED	Task execution failed

---

3. Get Last Run Time

Retrieve the last successful execution time of a specific task.

Endpoint: GET /api/scheduler/last-run/taskName}

Parameters:

Parameter	Type	Required	Description
taskName	String	Yes	Task name

Request:

curl "https://api.alaikis.com/std/api/scheduler/last-run/eu-vat-sync" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

Response:

{
  "code": 200,
  "msg": "Request successful",
  "data": "2026-05-21T02:00:00"
}

---

4. Get Task Overview

Retrieve a summary of all registered tasks including their status and last run time.

Endpoint: GET /api/scheduler/overview

Request:

curl "https://api.alaikis.com/std/api/scheduler/overview" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

Response:

{
  "code": 200,
  "msg": "Request successful",
  "data": {
    "totalTasks": 8,
    "tasks": [
      "china-tax-sync",
      "eu-vat-sync",
      "gst-sales-tax-sync",
      "hs-code-sync",
      "oecd-corporate-tax-sync",
      "postcode-sync",
      "un-numbers-sync",
      "wikipedia-vat-sync"
    ],
    "details": [
      {
        "taskName": "china-tax-sync",
        "status": "SUCCESS",
        "lastRun": "2026-05-21T02:00:00"
      },
      {
        "taskName": "eu-vat-sync",
        "status": "SUCCESS",
        "lastRun": "2026-05-21T02:15:00"
      },
      {
        "taskName": "gst-sales-tax-sync",
        "status": "SUCCESS",
        "lastRun": "2026-05-21T02:30:00"
      },
      {
        "taskName": "hs-code-sync",
        "status": "SUCCESS",
        "lastRun": "2026-05-01T03:00:00"
      },
      {
        "taskName": "oecd-corporate-tax-sync",
        "status": "SUCCESS",
        "lastRun": "2026-05-21T02:45:00"
      },
      {
        "taskName": "postcode-sync",
        "status": "SUCCESS",
        "lastRun": "2026-05-01T03:30:00"
      },
      {
        "taskName": "un-numbers-sync",
        "status": "SUCCESS",
        "lastRun": "2026-05-01T04:00:00"
      },
      {
        "taskName": "wikipedia-vat-sync",
        "status": "SUCCESS",
        "lastRun": "2026-05-21T02:00:00"
      }
    ]
  }
}

---

Registered Tasks Reference

Task Name	Description	Schedule	Related API
china-tax-sync	China tax rate synchronization	Monthly	Tax Rate API
eu-vat-sync	EU VAT rate synchronization	Daily	Tax Rate API
gst-sales-tax-sync	GST/SalesTax rate synchronization	Monthly	Tax Rate API
hs-code-sync	HS Code synchronization	Monthly	HS Code API
oecd-corporate-tax-sync	OECD corporate tax synchronization	Monthly	Tax Rate API
postcode-sync	Postcode data synchronization	Monthly	Big Data API
un-numbers-sync	UN Numbers synchronization	Monthly	UN Numbers API
wikipedia-vat-sync	Wikipedia VAT rate synchronization	Monthly	Tax Rate API