Get loyalty points export status

GET

https://uat-integration.returning.ai/apis/v1/loyalty-exports/{exportId}

Exports ordinary reward-coin history; XP and premium currency are excluded. Requires a community Bearer API key with customerSuccess permission and LOYALTY_EXPORTS_ENABLED=true. Personal keys are rejected. No per-key allowlist is required. Responses use Cache-Control: no-store; query parameters are rejected.

Poll after creating an export. Status is queued, processing, completed, failed, cancelled or expired. Completed jobs include total_rows and file_size_bytes. Empty ranges complete with zero rows. Failed jobs expose only error.code=EXPORT_FAILED. Other communities, unknown IDs and legacy exports return the same 404. Any authorized customerSuccess community key for the same community can read the job.

The existing Tradingroom export-history worker must run against the same MongoDB and Redis configuration. If a job stays queued, check that worker and its outbox dispatcher; the API request date range does not determine queue wait time.

Request

Authorization

Path Params

Responses

🟢200

application/json

Loyalty export status

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://uat-integration.returning.ai/apis/v1/loyalty-exports/cd799439012'

Response Example

200 - queued

{
    "meta": {
        "status": "success",
        "statusCode": 200,
        "requestId": "req_example"
    },
    "message": "Loyalty export status success.",
    "data": {
        "export_id": "507f1f77bcf86cd799439012",
        "status": "queued",
        "dataset": "points_transactions",
        "format": "csv",
        "created_at": "2026-09-28T03:00:00.000Z",
        "coverage": "observed_history_only"
    }
}

Modified at 2026-10-09 04:18:45

Create loyalty points export

Get loyalty points export download link