Skip to main content
GET
/
api
/
sys
/
businessbackgroundjobs
/
{id}
{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "UserId": 123,
  "UserFullName": "<string>",
  "UserEmail": "<string>",
  "JobId": "<string>",
  "Description": "<string>",
  "Files": "<string>",
  "Status": "<string>",
  "ResultData": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
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-Read role.

​
Path Parameters

​
id
integer
required
The Id of the BusinessBackgroundJob record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/businessbackgroundjobs/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
BusinessId
integer
Business Id.
​
BusinessName
string
Location name.
​
UserId
integer
User Id.
​
UserFullName
string
Full name of the user who triggered the job.
​
UserEmail
string
Email of the user who triggered the job.
​
JobId
string
Unique identifier (GUID) of the background job.
​
Description
string
Human-readable description of what the job does.
​
Files
string
Files associated with the job (e.g. import files).
​
Status
string
Current status of the background job.
​
ResultData
string
Result data produced when the job completes.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "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
}