Skip to main content
GET
/
api
/
sys
/
businessbackgroundjobs
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
A BusinessBackgroundJob is an internal, read-only entity representing background jobs used for bulk edits or imports. It is not intended for direct use by end users. Each record tracks a single asynchronous job: who triggered it, its current status, a human-readable description, and any result data produced when the job completes.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the BusinessBackgroundJob-List role.

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
BusinessBackgroundJob_Business
integer
Filter by Business Id.
​
BusinessBackgroundJob_Business_Name
string
Filter by location name.
​
BusinessBackgroundJob_User
integer
Filter by User Id.
​
BusinessBackgroundJob_User_FullName
string
Filter by full name of the user who triggered the job.
​
BusinessBackgroundJob_User_Email
string
Filter by email of the user who triggered the job.
​
BusinessBackgroundJob_JobId
string
Filter by unique identifier (GUID) of the background job.
​
BusinessBackgroundJob_Description
string
Filter by human-readable description of what the job does.
​
BusinessBackgroundJob_Files
string
Filter by files associated with the job (e.g. import files).
​
BusinessBackgroundJob_Status
string
Filter by current status of the background job.
​
BusinessBackgroundJob_ResultData
string
Filter by result data produced when the job completes.

​
Range Filters

​
from_BusinessBackgroundJob_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_BusinessBackgroundJob_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_BusinessBackgroundJob_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_BusinessBackgroundJob_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

​
Code Examples

​
Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/businessbackgroundjobs?page=1&size=15&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/sys/businessbackgroundjobs?BusinessBackgroundJob_CreatedOn=example-value&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/businessbackgroundjobs?from_BusinessBackgroundJob_UpdatedOn=2025-01-01T00:00&to_BusinessBackgroundJob_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
BusinessBackgroundJob[]
The list of BusinessBackgroundJob records matching the query. See the Get one BusinessBackgroundJob endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each BusinessBackgroundJob. The following fields are not included in the Records[] response: ResultData.To get all fields, fetch the full record using the Get one BusinessBackgroundJob endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "UserId": null,
      "UserFullName": null,
      "UserEmail": null,
      "JobId": null,
      "Description": null,
      "Files": null,
      "Status": null,
      "ResultData": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "BusinessBackgroundJob Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}