Skip to main content
GET
/
api
/
adm
/
backgroundProcesses
Get Background Processes
curl --request GET \
  --url https://localhost:44371/api/adm/backgroundProcesses \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "code": 200,
  "errorMessage": null
}

​
Description

Retrieves a list of background processes filtered by specified criteria such as status, date range, or process type. Results are paginated and sorted by creation date (newest first).

​
Input

  • Query Parameters: inputModel (BackgroundProcessQueryRequest) — Filtering options including:
    • status (string, optional) — Filter by process status (Pending, Running, Completed, Failed, Cancelled).
    • dateFrom (datetime, optional) — Start of date range filter.
    • dateTo (datetime, optional) — End of date range filter.
    • limit (int, optional) — Maximum number of records to return (default: 20).
    • offset (int, optional) — Number of records to skip for pagination.

​
Output

Returns a BackgroundProcessQueryResponse containing a list of background processes matching the filter criteria.

​
Example Request

GET /api/admin/backgroundProcesses?status=Running&limit=20
Authorization: Bearer {token}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "processType": "ImportTransactions",
      "status": "Running",
      "createdDate": "2025-10-27T10:30:00Z",
      "completedDate": null,
      "progressPercent": 45
    }
  ]
}

​
Errors

  • 400 Bad Request — Invalid filter parameters or date range.
  • 401 Unauthorized — Missing or invalid authentication token.

​
Notes

  • Requires admin-level authentication.
  • Results are sorted by creation date in descending order (newest first).

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
Type
enum<string>

Background process type filter.

Available options:
AccountUpdaterUploadFile,
AccountUpdaterDownloadFile,
DownloadChargebackReport,
ProcessImportBatches,
ReportDataSync,
CompanyProjectKeysRegenerate,
ServiceIndexes,
DownloadPurchaseRefundReport,
ExportReport,
CompanyAccessKeyExpiration,
CreateTransactionsFromChargebacks
Example:

"BackgroundProcessType.DownloadChargebacks"

​
Statuses
enum<string>[] | null

Collection of statuses to include in the results.

Available options:
Fail,
Done,
InProgress,
Pending,
Frozen,
PendingCancel,
Cancelled
Example:

"[BackgroundProcessStatus.Queued, BackgroundProcessStatus.Running]"

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Standard response structure containing operation status and error information. Represents the response returned when querying for background process entries.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null

​
entries
object[] | null

Background process entries that match the query.

Example:
[
  {
    "Id": "822a4c1c-64c9-4306-8e02-2d3c839f72a8",
    "Status": "Completed"
  }
]